diff --git a/trace/Trace/index.html b/trace/Trace/index.html index d28ae6d..91893ca 100644 --- a/trace/Trace/index.html +++ b/trace/Trace/index.html @@ -1,5 +1,5 @@ -Trace (trace.Trace)

Module Trace

Shim that just forwards to Trace_core.

The reason is, Trace is already defined in the compiler libs and can clash with this module inside a toplevel. So it's safer to only depend on Trace_core in libraries that might end up used in a toplevel.

include module type of struct include Trace_core end
type span = Trace_core.span = ..

A span. Its representation is defined by the current collector.

type parent = Trace_core.parent =
  1. | P_unknown
    (*

    Parent is not specified at this point

    *)
  2. | P_none
    (*

    We know the current span has no parent

    *)
  3. | P_some of span
    (*

    We know the parent of the current span

    *)

Information about a span's parent span, if any.

  • since NEXT_RELEASE
type user_data = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]

User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

type explicit_span = span
  • deprecated use span
type explicit_span_ctx = span
  • deprecated use span
type extension_parameter = Trace_core.extension_parameter = ..

An extension parameter, used to carry information for spans/messages/metrics that can be backend-specific or just not envisioned by trace.

  • since NEXT_RELEASE
module Collector = Trace_core.Collector
module Level = Trace_core.Level

Tracing

val enabled : unit -> bool

Is there a collector?

This is fast, so that the traced program can check it before creating any span or message.

val get_default_level : unit -> Level.t

Current default level for spans.

  • since 0.7
val set_default_level : Level.t -> unit

Set level used for spans that do not specify it. The default default value is Level.Trace.

  • since 0.7
val with_span : +Trace (trace.Trace)

Module Trace

Shim that just forwards to Trace_core.

The reason is, Trace is already defined in the compiler libs and can clash with this module inside a toplevel. So it's safer to only depend on Trace_core in libraries that might end up used in a toplevel.

include module type of struct include Trace_core end
type span = Trace_core.span = ..

A span. Its representation is defined by the current collector.

type parent = Trace_core.parent =
  1. | P_unknown
    (*

    Parent is not specified at this point

    *)
  2. | P_none
    (*

    We know the current span has no parent

    *)
  3. | P_some of span
    (*

    We know the parent of the current span

    *)

Information about a span's parent span, if any.

  • since NEXT_RELEASE
type user_data = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]

User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

type explicit_span = span
  • deprecated use span
type explicit_span_ctx = span
  • deprecated use span
type extension_parameter = Trace_core.extension_parameter = ..

An extension parameter, used to carry information for spans/messages/metrics that can be backend-specific or just not envisioned by trace.

  • since NEXT_RELEASE
type metric = Trace_core.metric = ..

A metric, can be of many types. See Core_ext for some builtin metrics.

  • since NEXT_RELEASE
module Collector = Trace_core.Collector
module Level = Trace_core.Level

Tracing

val enabled : unit -> bool

Is there a collector?

This is fast, so that the traced program can check it before creating any span or message.

val get_default_level : unit -> Level.t

Current default level for spans.

  • since 0.7
val set_default_level : Level.t -> unit

Set level used for spans that do not specify it. The default default value is Level.Trace.

  • since 0.7
val with_span : ?level:Level.t -> ?__FUNCTION__:string -> __FILE__:string -> @@ -31,19 +31,25 @@ ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> ((('a, Stdlib.Format.formatter, unit, unit) format4 -> 'a) -> unit) -> - unit

messagef (fun k->k"hello %s %d!" "world" 42) is like message "hello world 42!" but only computes the string formatting if a collector is installed.

See message for a description of the other arguments.

val set_thread_name : string -> unit

Give a name to the current thread. This might be used by the collector to display traces in a more informative way.

Uses Core_ext.Extension_set_thread_name since NEXT_RELEASE

val set_process_name : string -> unit

Give a name to the current process. This might be used by the collector to display traces in a more informative way.

Uses Core_ext.Extension_set_process_name since NEXT_RELEASE

val counter_int : + unit

messagef (fun k->k"hello %s %d!" "world" 42) is like message "hello world 42!" but only computes the string formatting if a collector is installed.

See message for a description of the other arguments.

val set_thread_name : string -> unit

Give a name to the current thread. This might be used by the collector to display traces in a more informative way.

Uses Core_ext.Extension_set_thread_name since NEXT_RELEASE

val set_process_name : string -> unit

Give a name to the current process. This might be used by the collector to display traces in a more informative way.

Uses Core_ext.Extension_set_process_name since NEXT_RELEASE

val metric : + ?level:Level.t -> + ?params:extension_parameter list -> + ?data:(unit -> (string * user_data) list) -> + string -> + metric -> + unit

Emit a metric. Metrics are an extensible type, each collector might support a different subset.

  • since NEXT_RELEASE
val counter_int : ?level:Level.t -> ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> string -> int -> - unit

Emit a counter of type int. Counters represent the evolution of some quantity over time.

  • parameter level

    optional level for this span. since 0.7. Default is set via set_default_level.

  • parameter data

    metadata for this metric (since 0.4)

val counter_float : + unit

Emit a counter of type int via metric. Counters represent the evolution of some quantity over time.

  • parameter level

    optional level for this span. since 0.7. Default is set via set_default_level.

  • parameter data

    metadata for this metric (since 0.4)

val counter_float : ?level:Level.t -> ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

Emit a counter of type float. See counter_int for more details.

  • parameter level

    optional level for this span. since 0.7. Default is set via set_default_level.

  • parameter data

    metadata for this metric (since 0.4)

Collector

type collector = Collector.t

An event collector. See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

  • raises Invalid_argument

    if there already is an established collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

  • since 0.7
val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

  • since 0.7
val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a

with_setup_collector c f installs c, calls f(), and shutdowns c once f() is done.

  • since NEXT_RELEASE

Extensions

type extension_event = ..

Extension event

  • since 0.8
val extension_event : extension_event -> unit

Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

  • since 0.8

Core extensions

module Core_ext = Trace_core.Core_ext

Deprecated

val enter_manual_span : + unit

Emit a counter of type float via metric. See counter_int for more details.

  • parameter level

    optional level for this span. since 0.7. Default is set via set_default_level.

  • parameter data

    metadata for this metric (since 0.4)

Collector

type collector = Collector.t

An event collector. See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

  • raises Invalid_argument

    if there already is an established collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

  • since 0.7
val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

  • since 0.7
val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a

with_setup_collector c f installs c, calls f(), and shutdowns c once f() is done.

  • since NEXT_RELEASE

Extensions

type extension_event = ..

Extension event

  • since 0.8
val extension_event : ?level:Level.t -> extension_event -> unit

Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

  • parameter level

    filtering level, since NEXT_RELEASE

  • since 0.8

Core extensions

module Core_ext = Trace_core.Core_ext

Deprecated

val enter_manual_span : parent:explicit_span_ctx option -> ?flavor:[ `Sync | `Async ] -> ?level:Level.t -> diff --git a/trace/Trace_core/Collector/Callbacks/index.html b/trace/Trace_core/Collector/Callbacks/index.html index f788522..feee146 100644 --- a/trace/Trace_core/Collector/Callbacks/index.html +++ b/trace/Trace_core/Collector/Callbacks/index.html @@ -3,6 +3,7 @@ __FUNCTION__:string option -> __FILE__:string -> __LINE__:int -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -24,6 +25,7 @@ | `None ]) list -> unit;
  • message : 'st -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -35,7 +37,8 @@ list -> span:Trace_core__.Types.span option -> string -> - unit;
    (*

    Emit a message or log

    *)
  • counter_int : 'st -> + unit;
    (*

    Emit a message or log

    *)
  • metric : 'st -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -46,25 +49,14 @@ | `None ]) list -> string -> - int -> - unit;
    (*

    Integer counter.

    *)
  • counter_float : 'st -> - params:Trace_core__.Types.extension_parameter list -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - float -> - unit;
  • extension : 'st -> Trace_core__.Types.extension_event -> unit;
    (*

    Collector-specific extension

    *)
  • init : 'st -> unit;
    (*

    Called on initialization

    *)
  • shutdown : 'st -> unit;
    (*

    Shutdown collector, possibly waiting for it to finish sending data.

    *)
    • }

    Callbacks taking a state 'st

    val make : + 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

    val make : enter_span: ('a -> __FUNCTION__:string option -> __FILE__:string -> __LINE__:int -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -91,6 +83,7 @@ unit) -> message: ('a -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -103,8 +96,9 @@ span:Trace_core__.Types.span option -> string -> unit) -> - counter_int: + metric: ('a -> + level:Level.t -> params:Trace_core__.Types.extension_parameter list -> data: (string @@ -115,23 +109,10 @@ | `None ]) list -> string -> - int -> + Trace_core__.Types.metric -> unit) -> - counter_float: - ('a -> - params:Trace_core__.Types.extension_parameter list -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - float -> - unit) -> - ?extension:('a -> Trace_core__.Types.extension_event -> unit) -> + ?extension: + ('a -> level:Level.t -> Trace_core__.Types.extension_event -> unit) -> ?init:('a -> unit) -> ?shutdown:('a -> unit) -> unit -> diff --git a/trace/Trace_core/Core_ext/index.html b/trace/Trace_core/Core_ext/index.html index 5b83378..6f2663e 100644 --- a/trace/Trace_core/Core_ext/index.html +++ b/trace/Trace_core/Core_ext/index.html @@ -1,2 +1,2 @@ -Core_ext (trace.Trace_core.Core_ext)

    Module Trace_core.Core_ext

    A few core extensions.

    • since NEXT_RELEASE
    type Trace_core__.Types.extension_event +=
    1. | Extension_set_thread_name of string
    2. | Extension_set_process_name of string

    Additional extensions

    type Trace_core__.Types.extension_parameter +=
    1. | Extension_span_flavor of [ `Async | `Sync ]
      (*

      Tell the backend if this is a sync or async span

      *)

    Specialized parameters

    +Core_ext (trace.Trace_core.Core_ext)

    Module Trace_core.Core_ext

    A few core extensions.

    • since NEXT_RELEASE
    type Trace_core__.Types.extension_event +=
    1. | Extension_set_thread_name of string
    2. | Extension_set_process_name of string

    Additional extensions

    type Trace_core__.Types.extension_parameter +=
    1. | Extension_span_flavor of [ `Async | `Sync ]
      (*

      Tell the backend if this is a sync or async span

      *)

    Specialized parameters

    type Trace_core__.Types.metric +=
    1. | Metric_int of int
      (*

      Int counter or gauge, supported by tracy, TEF, etc

      *)
    2. | Metric_float of float
      (*

      Float counter or gauge, supported by tracy, TEF, etc

      *)
    diff --git a/trace/Trace_core/index.html b/trace/Trace_core/index.html index ca80701..936e543 100644 --- a/trace/Trace_core/index.html +++ b/trace/Trace_core/index.html @@ -1,5 +1,5 @@ -Trace_core (trace.Trace_core)

    Module Trace_core

    Main tracing interface.

    This interface is intended to be lightweight and usable in both libraries and applications. It has very low overhead if no Collector.t is installed.

    type span = ..

    A span. Its representation is defined by the current collector.

    type parent =
    1. | P_unknown
      (*

      Parent is not specified at this point

      *)
    2. | P_none
      (*

      We know the current span has no parent

      *)
    3. | P_some of span
      (*

      We know the parent of the current span

      *)

    Information about a span's parent span, if any.

    • since NEXT_RELEASE
    type user_data = [
    1. | `Int of int
    2. | `String of string
    3. | `Bool of bool
    4. | `Float of float
    5. | `None
    ]

    User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

    type explicit_span = span
    • deprecated use span
    type explicit_span_ctx = span
    • deprecated use span
    type extension_parameter = ..

    An extension parameter, used to carry information for spans/messages/metrics that can be backend-specific or just not envisioned by trace.

    • since NEXT_RELEASE
    module Collector : sig ... end

    A global collector.

    module Level : sig ... end

    Tracing levels.

    Tracing

    val enabled : unit -> bool

    Is there a collector?

    This is fast, so that the traced program can check it before creating any span or message.

    val get_default_level : unit -> Level.t

    Current default level for spans.

    • since 0.7
    val set_default_level : Level.t -> unit

    Set level used for spans that do not specify it. The default default value is Level.Trace.

    • since 0.7
    val with_span : +Trace_core (trace.Trace_core)

    Module Trace_core

    Main tracing interface.

    This interface is intended to be lightweight and usable in both libraries and applications. It has very low overhead if no Collector.t is installed.

    type span = ..

    A span. Its representation is defined by the current collector.

    type parent =
    1. | P_unknown
      (*

      Parent is not specified at this point

      *)
    2. | P_none
      (*

      We know the current span has no parent

      *)
    3. | P_some of span
      (*

      We know the parent of the current span

      *)

    Information about a span's parent span, if any.

    • since NEXT_RELEASE
    type user_data = [
    1. | `Int of int
    2. | `String of string
    3. | `Bool of bool
    4. | `Float of float
    5. | `None
    ]

    User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

    type explicit_span = span
    • deprecated use span
    type explicit_span_ctx = span
    • deprecated use span
    type extension_parameter = ..

    An extension parameter, used to carry information for spans/messages/metrics that can be backend-specific or just not envisioned by trace.

    • since NEXT_RELEASE
    type metric = ..

    A metric, can be of many types. See Core_ext for some builtin metrics.

    • since NEXT_RELEASE
    module Collector : sig ... end

    A global collector.

    module Level : sig ... end

    Tracing levels.

    Tracing

    val enabled : unit -> bool

    Is there a collector?

    This is fast, so that the traced program can check it before creating any span or message.

    val get_default_level : unit -> Level.t

    Current default level for spans.

    • since 0.7
    val set_default_level : Level.t -> unit

    Set level used for spans that do not specify it. The default default value is Level.Trace.

    • since 0.7
    val with_span : ?level:Level.t -> ?__FUNCTION__:string -> __FILE__:string -> @@ -31,19 +31,25 @@ ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> ((('a, Stdlib.Format.formatter, unit, unit) format4 -> 'a) -> unit) -> - unit

    messagef (fun k->k"hello %s %d!" "world" 42) is like message "hello world 42!" but only computes the string formatting if a collector is installed.

    See message for a description of the other arguments.

    val set_thread_name : string -> unit

    Give a name to the current thread. This might be used by the collector to display traces in a more informative way.

    Uses Core_ext.Extension_set_thread_name since NEXT_RELEASE

    val set_process_name : string -> unit

    Give a name to the current process. This might be used by the collector to display traces in a more informative way.

    Uses Core_ext.Extension_set_process_name since NEXT_RELEASE

    val counter_int : + unit

    messagef (fun k->k"hello %s %d!" "world" 42) is like message "hello world 42!" but only computes the string formatting if a collector is installed.

    See message for a description of the other arguments.

    val set_thread_name : string -> unit

    Give a name to the current thread. This might be used by the collector to display traces in a more informative way.

    Uses Core_ext.Extension_set_thread_name since NEXT_RELEASE

    val set_process_name : string -> unit

    Give a name to the current process. This might be used by the collector to display traces in a more informative way.

    Uses Core_ext.Extension_set_process_name since NEXT_RELEASE

    val metric : + ?level:Level.t -> + ?params:extension_parameter list -> + ?data:(unit -> (string * user_data) list) -> + string -> + metric -> + unit

    Emit a metric. Metrics are an extensible type, each collector might support a different subset.

    • since NEXT_RELEASE
    val counter_int : ?level:Level.t -> ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> string -> int -> - unit

    Emit a counter of type int. Counters represent the evolution of some quantity over time.

    • parameter level

      optional level for this span. since 0.7. Default is set via set_default_level.

    • parameter data

      metadata for this metric (since 0.4)

    val counter_float : + unit

    Emit a counter of type int via metric. Counters represent the evolution of some quantity over time.

    • parameter level

      optional level for this span. since 0.7. Default is set via set_default_level.

    • parameter data

      metadata for this metric (since 0.4)

    val counter_float : ?level:Level.t -> ?params:extension_parameter list -> ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

    Emit a counter of type float. See counter_int for more details.

    • parameter level

      optional level for this span. since 0.7. Default is set via set_default_level.

    • parameter data

      metadata for this metric (since 0.4)

    Collector

    type collector = Collector.t

    An event collector. See Collector for more details.

    val setup_collector : collector -> unit

    setup_collector c installs c as the current collector.

    • raises Invalid_argument

      if there already is an established collector.

    val get_current_level : unit -> Level.t

    Get current level. This is only meaningful if a collector was set up with setup_collector.

    • since 0.7
    val set_current_level : Level.t -> unit

    Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

    • since 0.7
    val shutdown : unit -> unit

    shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

    val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a

    with_setup_collector c f installs c, calls f(), and shutdowns c once f() is done.

    • since NEXT_RELEASE

    Extensions

    type extension_event = ..

    Extension event

    • since 0.8
    val extension_event : extension_event -> unit

    Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

    • since 0.8

    Core extensions

    module Core_ext : sig ... end

    A few core extensions.

    Deprecated

    val enter_manual_span : + unit

    Emit a counter of type float via metric. See counter_int for more details.

    • parameter level

      optional level for this span. since 0.7. Default is set via set_default_level.

    • parameter data

      metadata for this metric (since 0.4)

    Collector

    type collector = Collector.t

    An event collector. See Collector for more details.

    val setup_collector : collector -> unit

    setup_collector c installs c as the current collector.

    • raises Invalid_argument

      if there already is an established collector.

    val get_current_level : unit -> Level.t

    Get current level. This is only meaningful if a collector was set up with setup_collector.

    • since 0.7
    val set_current_level : Level.t -> unit

    Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

    • since 0.7
    val shutdown : unit -> unit

    shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

    val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a

    with_setup_collector c f installs c, calls f(), and shutdowns c once f() is done.

    • since NEXT_RELEASE

    Extensions

    type extension_event = ..

    Extension event

    • since 0.8
    val extension_event : ?level:Level.t -> extension_event -> unit

    Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

    • parameter level

      filtering level, since NEXT_RELEASE

    • since 0.8

    Core extensions

    module Core_ext : sig ... end

    A few core extensions.

    Deprecated

    val enter_manual_span : parent:explicit_span_ctx option -> ?flavor:[ `Sync | `Async ] -> ?level:Level.t ->