package trace

You can search for identifiers within the package.

in-package search v0.2.0

A lightweight stub for tracing/observability, agnostic in how data is collected

Install

dune-project

Dependency

github.com Readme Changelog Edit opam file Versions (14)

Authors

S

Simon Cruanes

Maintainers

S

Simon Cruanes

Sources

trace-0.11.tbz

sha256=a29329fcfb191a98bfed26c05c300ed9e1e915b73cc59f51e9d9cdc4d1f158bc

sha512=ff77a4ef19375f4ad3b1ddff7336657a4a5695924b679ac2c36a77b14b95c63d126539efd1590f83b415a1288bb843a5fb4308e53a807dcc22456cb40a8e0026

doc/trace.core/Trace_core/Collector/Callbacks/index.html

Module `Collector.Callbacks`Source

Sourcetype 'st t = {

enter_span : 'st -> __FUNCTION__:string option -> __FILE__:string -> __LINE__:int -> level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string * [ `Int of int | `String of string | `Bool of bool | `Float of float | `None ]) list -> parent:Trace_core__.Types.parent -> string -> Trace_core__.Types.span;
(*
Enter a span
*)
exit_span : 'st -> Trace_core__.Types.span -> unit;
(*
Exit a span. Must be called exactly once per span. Additional constraints on nesting, threads, etc. vary per collector.
*)
add_data_to_span : 'st -> Trace_core__.Types.span -> (string * [ `Int of int | `String of string | `Bool of bool | `Float of float | `None ]) list -> unit;
enabled : 'st -> Level.t -> bool;
(*
Is the collector accepting spans/messages/metrics with this level?
*)
message : 'st -> level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string * [ `Int of int | `String of string | `Bool of bool | `Float of float | `None ]) list -> span:Trace_core__.Types.span option -> string -> unit;
(*
Emit a message or log
*)
metric : 'st -> level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string * [ `Int of int | `String of string | `Bool of bool | `Float of float | `None ]) list -> string -> Trace_core__.Types.metric -> unit;
(*
Metric .
*)
extension : 'st -> level:Level.t -> Trace_core__.Types.extension_event -> unit;
(*
Collector-specific extension. It now has a level as well.
*)
init : 'st -> unit;
(*
Called on initialization
*)
shutdown : 'st -> unit;
(*
Shutdown collector, possibly waiting for it to finish sending data.
*)

}

Callbacks taking a state 'st

Source

val make : 
  ?enabled:('a -> Level.t -> bool) ->
  enter_span:
    ('a ->
      __FUNCTION__:string option ->
      __FILE__:string ->
      __LINE__:int ->
      level:Level.t ->
      params:Trace_core__.Types.extension_parameter list ->
      data:
        (string
         * [ `Int of int
           | `String of string
           | `Bool of bool
           | `Float of float
           | `None ])
          list ->
      parent:Trace_core__.Types.parent ->
      string ->
      Trace_core__.Types.span) ->
  exit_span:('a -> Trace_core__.Types.span -> unit) ->
  add_data_to_span:
    ('a ->
      Trace_core__.Types.span ->
      (string
       * [ `Int of int
         | `String of string
         | `Bool of bool
         | `Float of float
         | `None ])
        list ->
      unit) ->
  message:
    ('a ->
      level:Level.t ->
      params:Trace_core__.Types.extension_parameter list ->
      data:
        (string
         * [ `Int of int
           | `String of string
           | `Bool of bool
           | `Float of float
           | `None ])
          list ->
      span:Trace_core__.Types.span option ->
      string ->
      unit) ->
  metric:
    ('a ->
      level:Level.t ->
      params:Trace_core__.Types.extension_parameter list ->
      data:
        (string
         * [ `Int of int
           | `String of string
           | `Bool of bool
           | `Float of float
           | `None ])
          list ->
      string ->
      Trace_core__.Types.metric ->
      unit) ->
  ?extension:
    ('a -> level:Level.t -> Trace_core__.Types.extension_event -> unit) ->
  ?init:('a -> unit) ->
  ?shutdown:('a -> unit) ->
  unit ->
  'a t

Helper to create backends in a future-proof way