simon/ocaml-trace
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-trace.git synced 2026-03-07 18:37:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc

Browse source
This commit is contained in:
Simon Cruanes 2026-03-03 08:47:46 -05:00
parent dd30ae0858
commit 41b152c789
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
2 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/core/types.ml
View file

@ -1,7 +1,9 @@
(** Main type definitions *)
type span = ..
(** A span. Its representation is defined by the current collector. *)
(** A span. Its representation is defined by the current collector.
This representation changed in 0.11 (from [int64] to an open sum type) *)
(** Information about a span's parent span, if any.
@since 0.11 *)

7
src/tls/trace_thread_local_storage.mli
View file

@ -1,7 +1,9 @@
(** use [thread-local-storage] to store ambient spans.
This doesn't work with cooperative concurrency (Eio, Lwt, etc) but is fine
in a threaded context. *)
in a threaded context.
@since 0.12 *)
open Trace_core
@ -9,6 +11,9 @@ val k_span : span Thread_local_storage.t
(** Key to access the current span *)
val provider : Ambient_span_provider.t
(** Provider that uses [Thread_local_storage] to store the current ambient span.
This works well when concurrency is based on thread, or if there is no
concurrency. *)
val setup : unit -> unit
(** Install the provider *)