diff --git a/ppx_trace/_doc-dir/CHANGES.md b/ppx_trace/_doc-dir/CHANGES.md index 89274fb..b07408c 100644 --- a/ppx_trace/_doc-dir/CHANGES.md +++ b/ppx_trace/_doc-dir/CHANGES.md @@ -1,3 +1,12 @@ +# 0.12 + +- use `current_span` when entering spans or sending messages +- add `Trace.Ambient_span_provider.t` concept, to track the current span. + It is not part of the collector and is optional. +- add `trace.thread-local-storage` optional library that implements the `Ambient_span_provider.t` +- add a runtime events collector, + test, in `trace-runtime-events` +- add `{thread,process}_sort_index` extension + TEF support + # 0.11 - entire rework of the collector, now lighter, and using an open sum type diff --git a/trace-fuchsia/_doc-dir/CHANGES.md b/trace-fuchsia/_doc-dir/CHANGES.md index 89274fb..b07408c 100644 --- a/trace-fuchsia/_doc-dir/CHANGES.md +++ b/trace-fuchsia/_doc-dir/CHANGES.md @@ -1,3 +1,12 @@ +# 0.12 + +- use `current_span` when entering spans or sending messages +- add `Trace.Ambient_span_provider.t` concept, to track the current span. + It is not part of the collector and is optional. +- add `trace.thread-local-storage` optional library that implements the `Ambient_span_provider.t` +- add a runtime events collector, + test, in `trace-runtime-events` +- add `{thread,process}_sort_index` extension + TEF support + # 0.11 - entire rework of the collector, now lighter, and using an open sum type diff --git a/trace-tef/_doc-dir/CHANGES.md b/trace-tef/_doc-dir/CHANGES.md index 89274fb..b07408c 100644 --- a/trace-tef/_doc-dir/CHANGES.md +++ b/trace-tef/_doc-dir/CHANGES.md @@ -1,3 +1,12 @@ +# 0.12 + +- use `current_span` when entering spans or sending messages +- add `Trace.Ambient_span_provider.t` concept, to track the current span. + It is not part of the collector and is optional. +- add `trace.thread-local-storage` optional library that implements the `Ambient_span_provider.t` +- add a runtime events collector, + test, in `trace-runtime-events` +- add `{thread,process}_sort_index` extension + TEF support + # 0.11 - entire rework of the collector, now lighter, and using an open sum type diff --git a/trace/Trace/index.html b/trace/Trace/index.html index 621b87f..f22278f 100644 --- a/trace/Trace/index.html +++ b/trace/Trace/index.html @@ -49,7 +49,7 @@ ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

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

val current_span : unit -> span option

Access the current span from some ambient scope, if supported. This is only supported if a Ambient_span_provider has been set up.

val with_current_span_set_to : span -> (span -> 'a) -> 'a

with_current_span_set_to span f sets the span as current span, enters f span, and restores the previous current span (if any).

This is only supported if a Ambient_span_provider has been set up, otherwise it is a no-op.

Automatically called by with_span.

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.

val get_current_level : unit -> Level.t

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

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.

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.

ambient span provider

val set_ambient_context_provider : Ambient_span_provider.t -> unit

Install a provider for current_span and with_current_span_set_to. The default provider does nothing (ie current_span () is always None).

Extensions

type extension_event = ..

Extension event

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.

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.

val current_span : unit -> span option

Access the current span from some ambient scope, if supported. This is only supported if a Ambient_span_provider has been set up.

val with_current_span_set_to : span -> (span -> 'a) -> 'a

with_current_span_set_to span f sets the span as current span, enters f span, and restores the previous current span (if any).

This is only supported if a Ambient_span_provider has been set up, otherwise it is a no-op.

Automatically called by with_span.

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.

val get_current_level : unit -> Level.t

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

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.

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.

ambient span provider

val set_ambient_context_provider : Ambient_span_provider.t -> unit

Install a provider for current_span and with_current_span_set_to. The default provider does nothing (ie current_span () is always None).

Extensions

type extension_event = ..

Extension event

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.

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/Ambient_span_provider/index.html b/trace/Trace_core/Ambient_span_provider/index.html index b81cd1e..1875371 100644 --- a/trace/Trace_core/Ambient_span_provider/index.html +++ b/trace/Trace_core/Ambient_span_provider/index.html @@ -1,2 +1,2 @@ -Ambient_span_provider (trace.Trace_core.Ambient_span_provider)

Module Trace_core.Ambient_span_provider

Access/set the current span from some ambient context.

  • since NEXT_RELEASE
module Callbacks : sig ... end
type t =
  1. | ASP_none
  2. | ASP_some : 'st * 'st Callbacks.t -> t
+Ambient_span_provider (trace.Trace_core.Ambient_span_provider)

Module Trace_core.Ambient_span_provider

Access/set the current span from some ambient context.

  • since 0.12
module Callbacks : sig ... end
type t =
  1. | ASP_none
  2. | ASP_some : 'st * 'st Callbacks.t -> t
diff --git a/trace/Trace_core/index.html b/trace/Trace_core/index.html index 27da808..e45673f 100644 --- a/trace/Trace_core/index.html +++ b/trace/Trace_core/index.html @@ -49,7 +49,7 @@ ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

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

val current_span : unit -> span option

Access the current span from some ambient scope, if supported. This is only supported if a Ambient_span_provider has been set up.

val with_current_span_set_to : span -> (span -> 'a) -> 'a

with_current_span_set_to span f sets the span as current span, enters f span, and restores the previous current span (if any).

This is only supported if a Ambient_span_provider has been set up, otherwise it is a no-op.

Automatically called by with_span.

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.

val get_current_level : unit -> Level.t

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

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.

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.

ambient span provider

val set_ambient_context_provider : Ambient_span_provider.t -> unit

Install a provider for current_span and with_current_span_set_to. The default provider does nothing (ie current_span () is always None).

Extensions

type extension_event = ..

Extension event

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.

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.

val current_span : unit -> span option

Access the current span from some ambient scope, if supported. This is only supported if a Ambient_span_provider has been set up.

val with_current_span_set_to : span -> (span -> 'a) -> 'a

with_current_span_set_to span f sets the span as current span, enters f span, and restores the previous current span (if any).

This is only supported if a Ambient_span_provider has been set up, otherwise it is a no-op.

Automatically called by with_span.

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.

val get_current_level : unit -> Level.t

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

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.

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.

ambient span provider

val set_ambient_context_provider : Ambient_span_provider.t -> unit

Install a provider for current_span and with_current_span_set_to. The default provider does nothing (ie current_span () is always None).

Extensions

type extension_event = ..

Extension event

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.

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 -> diff --git a/trace/_doc-dir/CHANGES.md b/trace/_doc-dir/CHANGES.md index 89274fb..b07408c 100644 --- a/trace/_doc-dir/CHANGES.md +++ b/trace/_doc-dir/CHANGES.md @@ -1,3 +1,12 @@ +# 0.12 + +- use `current_span` when entering spans or sending messages +- add `Trace.Ambient_span_provider.t` concept, to track the current span. + It is not part of the collector and is optional. +- add `trace.thread-local-storage` optional library that implements the `Ambient_span_provider.t` +- add a runtime events collector, + test, in `trace-runtime-events` +- add `{thread,process}_sort_index` extension + TEF support + # 0.11 - entire rework of the collector, now lighter, and using an open sum type