mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-09 12:23:32 -04:00
update next tag
This commit is contained in:
parent
c711a0dc66
commit
627164afd0
5 changed files with 15 additions and 15 deletions
|
|
@ -82,7 +82,7 @@ end
|
||||||
This is only relevant to implementors of tracing backends; to instrument
|
This is only relevant to implementors of tracing backends; to instrument
|
||||||
your code you only need to look at the {!Trace} module.
|
your code you only need to look at the {!Trace} module.
|
||||||
|
|
||||||
The definition changed since NEXT_RELEASE to a record of callbacks + a state
|
The definition changed since 0.11 to a record of callbacks + a state
|
||||||
*)
|
*)
|
||||||
type t =
|
type t =
|
||||||
| C_none (** No collector. *)
|
| C_none (** No collector. *)
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
(** A few core extensions.
|
(** A few core extensions.
|
||||||
|
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
||||||
open Types
|
open Types
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -54,10 +54,10 @@ val with_span :
|
||||||
@param level
|
@param level
|
||||||
optional level for this span. since 0.7. Default is set via
|
optional level for this span. since 0.7. Default is set via
|
||||||
{!set_default_level}.
|
{!set_default_level}.
|
||||||
@param parent the span's parent, if any. since NEXT_RELEASE.
|
@param parent the span's parent, if any. since 0.11.
|
||||||
@param params
|
@param params
|
||||||
extension parameters, used to communicate additional information to the
|
extension parameters, used to communicate additional information to the
|
||||||
collector. It might be collector-specific. since NEXT_RELEASE.
|
collector. It might be collector-specific. since 0.11.
|
||||||
|
|
||||||
Depending on the collector, this might clash with some forms of cooperative
|
Depending on the collector, this might clash with some forms of cooperative
|
||||||
concurrency in which [with_span (fun span -> …)] might contain a yield
|
concurrency in which [with_span (fun span -> …)] might contain a yield
|
||||||
|
|
@ -83,7 +83,7 @@ val enter_span :
|
||||||
@param level
|
@param level
|
||||||
optional level for this span. since 0.7. Default is set via
|
optional level for this span. since 0.7. Default is set via
|
||||||
{!set_default_level}.
|
{!set_default_level}.
|
||||||
@param parent the span's parent, if any. since NEXT_RELEASE.
|
@param parent the span's parent, if any. since 0.11.
|
||||||
@param params see {!with_span}. *)
|
@param params see {!with_span}. *)
|
||||||
|
|
||||||
val exit_span : span -> unit
|
val exit_span : span -> unit
|
||||||
|
|
@ -114,7 +114,7 @@ val message :
|
||||||
the surrounding span, if any. This might be ignored by the collector.
|
the surrounding span, if any. This might be ignored by the collector.
|
||||||
@param params
|
@param params
|
||||||
extension parameters, used to communicate additional information to the
|
extension parameters, used to communicate additional information to the
|
||||||
collector. It might be collector-specific. since NEXT_RELEASE. *)
|
collector. It might be collector-specific. since 0.11. *)
|
||||||
|
|
||||||
val messagef :
|
val messagef :
|
||||||
?level:Level.t ->
|
?level:Level.t ->
|
||||||
|
|
@ -133,13 +133,13 @@ val set_thread_name : string -> unit
|
||||||
(** Give a name to the current thread. This might be used by the collector to
|
(** Give a name to the current thread. This might be used by the collector to
|
||||||
display traces in a more informative way.
|
display traces in a more informative way.
|
||||||
|
|
||||||
Uses {!Core_ext.Extension_set_thread_name} since NEXT_RELEASE *)
|
Uses {!Core_ext.Extension_set_thread_name} since 0.11 *)
|
||||||
|
|
||||||
val set_process_name : string -> unit
|
val set_process_name : string -> unit
|
||||||
(** Give a name to the current process. This might be used by the collector to
|
(** Give a name to the current process. This might be used by the collector to
|
||||||
display traces in a more informative way.
|
display traces in a more informative way.
|
||||||
|
|
||||||
Uses {!Core_ext.Extension_set_process_name} since NEXT_RELEASE *)
|
Uses {!Core_ext.Extension_set_process_name} since 0.11 *)
|
||||||
|
|
||||||
val metric :
|
val metric :
|
||||||
?level:Level.t ->
|
?level:Level.t ->
|
||||||
|
|
@ -150,7 +150,7 @@ val metric :
|
||||||
unit
|
unit
|
||||||
(** Emit a metric. Metrics are an extensible type, each collector might support
|
(** Emit a metric. Metrics are an extensible type, each collector might support
|
||||||
a different subset.
|
a different subset.
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
||||||
val counter_int :
|
val counter_int :
|
||||||
?level:Level.t ->
|
?level:Level.t ->
|
||||||
|
|
@ -206,7 +206,7 @@ val shutdown : unit -> unit
|
||||||
val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a
|
val with_setup_collector : Collector.t -> (unit -> 'a) -> 'a
|
||||||
(** [with_setup_collector c f] installs [c], calls [f()], and shutdowns [c] once
|
(** [with_setup_collector c f] installs [c], calls [f()], and shutdowns [c] once
|
||||||
[f()] is done.
|
[f()] is done.
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
||||||
(** {2 Extensions} *)
|
(** {2 Extensions} *)
|
||||||
|
|
||||||
|
|
@ -218,7 +218,7 @@ val extension_event : ?level:Level.t -> extension_event -> unit
|
||||||
(** Trigger an extension event, whose meaning depends on the library that
|
(** Trigger an extension event, whose meaning depends on the library that
|
||||||
defines it. Some collectors will simply ignore it. This does nothing if no
|
defines it. Some collectors will simply ignore it. This does nothing if no
|
||||||
collector is setup.
|
collector is setup.
|
||||||
@param level filtering level, since NEXT_RELEASE
|
@param level filtering level, since 0.11
|
||||||
@since 0.8 *)
|
@since 0.8 *)
|
||||||
|
|
||||||
(** {2 Core extensions} *)
|
(** {2 Core extensions} *)
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ type span = ..
|
||||||
(** A span. Its representation is defined by the current collector. *)
|
(** A span. Its representation is defined by the current collector. *)
|
||||||
|
|
||||||
(** Information about a span's parent span, if any.
|
(** Information about a span's parent span, if any.
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
type parent =
|
type parent =
|
||||||
| P_unknown (** Parent is not specified at this point *)
|
| P_unknown (** Parent is not specified at this point *)
|
||||||
| P_none (** We know the current span has no parent *)
|
| P_none (** We know the current span has no parent *)
|
||||||
|
|
@ -32,8 +32,8 @@ type extension_event = ..
|
||||||
type extension_parameter = ..
|
type extension_parameter = ..
|
||||||
(** An extension parameter, used to carry information for spans/messages/metrics
|
(** An extension parameter, used to carry information for spans/messages/metrics
|
||||||
that can be backend-specific or just not envisioned by [trace].
|
that can be backend-specific or just not envisioned by [trace].
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
||||||
type metric = ..
|
type metric = ..
|
||||||
(** A metric, can be of many types. See {!Core_ext} for some builtin metrics.
|
(** A metric, can be of many types. See {!Core_ext} for some builtin metrics.
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
This is a concrete representation of spans that is convenient to manipulate.
|
This is a concrete representation of spans that is convenient to manipulate.
|
||||||
|
|
||||||
@since NEXT_RELEASE *)
|
@since 0.11 *)
|
||||||
|
|
||||||
open Trace_core
|
open Trace_core
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue