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

fix docs

Browse source
This commit is contained in:
Simon Cruanes 2023-10-11 13:29:37 -04:00
parent 4624d1800c
commit f3ae3397de
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/core/collector.ml
View file

@ -55,12 +55,12 @@ module type S = sig
val add_data_to_span : span -> (string * user_data) list -> unit val add_data_to_span : span -> (string * user_data) list -> unit
(** @since Adds data to the current span. (** @since Adds data to the current span.
NEXT_RELEASE *) 0.4 *)
val add_data_to_manual_span : val add_data_to_manual_span :
explicit_span -> (string * user_data) list -> unit explicit_span -> (string * user_data) list -> unit
(** Adds data to the given span. (** Adds data to the given span.
@since NEXT_RELEASE *) @since 0.4 *)
val message : ?span:span -> data:(string * user_data) list -> string -> unit val message : ?span:span -> data:(string * user_data) list -> string -> unit
(** Emit a message with associated metadata. *) (** Emit a message with associated metadata. *)

8
src/core/trace_core.mli
View file

@ -37,7 +37,7 @@ val with_span :
val add_data_to_span : span -> (string * user_data) list -> unit val add_data_to_span : span -> (string * user_data) list -> unit
(** Add structured data to the given active span (see {!with_span}). (** Add structured data to the given active span (see {!with_span}).
Behavior is not specified if the span has been exited. Behavior is not specified if the span has been exited.
@since NEXT_RELEASE *) @since 0.4 *)
val enter_manual_sub_span : val enter_manual_sub_span :
parent:explicit_span -> parent:explicit_span ->
@ -83,7 +83,7 @@ val exit_manual_span : explicit_span -> unit
val add_data_to_manual_span : explicit_span -> (string * user_data) list -> unit val add_data_to_manual_span : explicit_span -> (string * user_data) list -> unit
(** [add_data_explicit esp data] adds [data] to the span [esp]. (** [add_data_explicit esp data] adds [data] to the span [esp].
The behavior is not specified is the span has been exited already. The behavior is not specified is the span has been exited already.
@since NEXT_RELEASE *) @since 0.4 *)
val message : val message :
?span:span -> ?data:(unit -> (string * user_data) list) -> string -> unit ?span:span -> ?data:(unit -> (string * user_data) list) -> string -> unit
@ -114,12 +114,12 @@ val counter_int :
?data:(unit -> (string * user_data) list) -> string -> int -> unit ?data:(unit -> (string * user_data) list) -> string -> int -> unit
(** Emit a counter of type [int]. Counters represent the evolution of some quantity (** Emit a counter of type [int]. Counters represent the evolution of some quantity
over time. over time.
@param data metadata for this metric (since NEXT_RELEASE) *) @param data metadata for this metric (since 0.4) *)
val counter_float : val counter_float :
?data:(unit -> (string * user_data) list) -> string -> float -> unit ?data:(unit -> (string * user_data) list) -> string -> float -> unit
(** Emit a counter of type [float]. See {!counter_int} for more details. (** Emit a counter of type [float]. See {!counter_int} for more details.
@param data metadata for this metric (since NEXT_RELEASE) *) @param data metadata for this metric (since 0.4) *)
(** {2 Collector} *) (** {2 Collector} *)