simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-08 20:07:55 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add a note about well-known-id stability

Browse source
This commit is contained in:
Elliott Cable 2023-08-30 02:30:14 +00:00
parent 9ecd73cb26
commit f9ea704399
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/trace/opentelemetry_trace.mli
View file

@ -2,7 +2,7 @@ module Otel := Opentelemetry
module Otrace := Trace module Otrace := Trace
module TLS := Ambient_context_tls.Thread_local module TLS := Ambient_context_tls.Thread_local
(** [ocaml-opentelemetry.trace] implements a {!Trace_core.Collector} for (** [opentelemetry.trace] implements a {!Trace_core.Collector} for
{{:https://v3.ocaml.org/p/trace} ocaml-trace}. {{:https://v3.ocaml.org/p/trace} ocaml-trace}.
After installing this collector with {!setup}, you can consume libraries After installing this collector with {!setup}, you can consume libraries
@ -18,7 +18,10 @@ module TLS := Ambient_context_tls.Thread_local
Because [ocaml-trace]'s API is a subset of OpenTelemetry functionality, this Because [ocaml-trace]'s API is a subset of OpenTelemetry functionality, this
interface allows for a few 'well-known' identifiers to be used in interface allows for a few 'well-known' identifiers to be used in
[Trace]-instrumented libraries that wish to further support OpenTelemetry [Trace]-instrumented libraries that wish to further support OpenTelemetry
usage: usage.
(These strings will not change in subsequent versions of this library, so
you do not need to depend on [opentelemetry.trace] to use them.)
- If a key of exactly ["otrace.spankind"] is included in the - If a key of exactly ["otrace.spankind"] is included in the
{!Trace.user_data} passed to [with_span] et al., it will be used as the {!Trace.user_data} passed to [with_span] et al., it will be used as the