diff --git a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html index 163b7951..9919534a 100644 --- a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html +++ b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html @@ -1,7 +1,8 @@ -Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)

Module Opentelemetry_client_ocurl.Config

type t = {
debug : bool;
url : string;(*

Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.

*)
batch_traces : int option;(*

Batch traces? If Some i, then this produces batches of (at most) i items. If None, there is no batching.

Note that traces and metrics are batched separately. Default Some 400.

*)
batch_metrics : int option;(*

Batch metrics? If Some i, then this produces batches of (at most) i items. If None, there is no batching.

Note that traces and metrics are batched separately. Default None.

*)
batch_timeout_ms : int;(*

Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs. Default 500.

*)
thread : bool;(*

Is there a background thread? Default true

*)
ticker_thread : bool;(*

Is there a ticker thread? Default true. This thread will regularly call tick() on the backend, to make sure it makes progress, and regularly send events to the collector. This option is ignored if thread=false.

*)
}
val make : +Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)

Module Opentelemetry_client_ocurl.Config

type t = {
debug : bool;
url : string;(*

Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.

*)
headers : (string * string) list;(*

API headers sent to the endpoint. Default is none or "OTEL_EXPORTER_OTLP_HEADERS" if set.

*)
batch_traces : int option;(*

Batch traces? If Some i, then this produces batches of (at most) i items. If None, there is no batching.

Note that traces and metrics are batched separately. Default Some 400.

*)
batch_metrics : int option;(*

Batch metrics? If Some i, then this produces batches of (at most) i items. If None, there is no batching.

Note that traces and metrics are batched separately. Default None.

*)
batch_timeout_ms : int;(*

Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs. Default 500.

*)
thread : bool;(*

Is there a background thread? Default true

*)
ticker_thread : bool;(*

Is there a ticker thread? Default true. This thread will regularly call tick() on the backend, to make sure it makes progress, and regularly send events to the collector. This option is ignored if thread=false.

*)
}
val make : ?debug:bool -> ?url:string -> + ?headers:(string * string) list -> ?batch_traces:int option -> ?batch_metrics:int option -> ?batch_timeout_ms:int -> diff --git a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html index ef20ffe0..757244b5 100644 --- a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html +++ b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html @@ -1,5 +1,5 @@ -Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)

Module Opentelemetry_client_ocurl

val get_url : unit -> string
val set_url : string -> unit

Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.

val set_mutex : lock:( unit -> unit ) -> unlock:( unit -> unit ) -> unit

Set a lock/unlock pair to protect the critical sections of Opentelemetry.Collector.BACKEND

module Config : sig ... end
val setup : ?config:Config.t -> ?enable:bool -> unit -> unit

Setup endpoint. This modifies Opentelemetry.Collector.backend.

  • parameter enable

    actually setup the backend (default true). This can be used to enable/disable the setup depending on CLI arguments or environment.

  • parameter config

    configuration to use

val with_setup : +Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)

Module Opentelemetry_client_ocurl

val get_url : unit -> string
val set_url : string -> unit

Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.

val get_headers : unit -> (string * string) list
val set_headers : (string * string) list -> unit

Set http headers that are sent on every http query to the collector.

val set_mutex : lock:( unit -> unit ) -> unlock:( unit -> unit ) -> unit

Set a lock/unlock pair to protect the critical sections of Opentelemetry.Collector.BACKEND

module Config : sig ... end
val setup : ?config:Config.t -> ?enable:bool -> unit -> unit

Setup endpoint. This modifies Opentelemetry.Collector.backend.

  • parameter enable

    actually setup the backend (default true). This can be used to enable/disable the setup depending on CLI arguments or environment.

  • parameter config

    configuration to use

val with_setup : ?config:Config.t -> ?enable:bool -> unit -> diff --git a/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html b/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html index 89ee202c..793b769a 100644 --- a/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html +++ b/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html @@ -1,5 +1,5 @@ -Metrics (opentelemetry-lwt.Opentelemetry_lwt.Metrics)

Module Opentelemetry_lwt.Metrics

include module type of struct include Opentelemetry.Metrics end

Metrics.

See the spec

type t
val _program_start : Opentelemetry.Timestamp_ns.t
val float : +Metrics (opentelemetry-lwt.Opentelemetry_lwt.Metrics)

Module Opentelemetry_lwt.Metrics

include module type of struct include Opentelemetry.Metrics end

Metrics.

See the spec

type t

A single metric, measuring some time-varying quantity or statistical distribution. It is composed of one or more data points that have precise values and time stamps. Each distinct metric should have a distinct name.

val float : ?start_time_unix_nano:Opentelemetry.Timestamp_ns.t -> ?now:Opentelemetry.Timestamp_ns.t -> ?attrs: @@ -25,7 +25,25 @@ ?aggregation_temporality:aggregation_temporality -> ?is_monotonic:bool -> Opentelemetry__Metrics_types.number_data_point list -> - t

Sum of all reported measurements over a time interval

val make_resource_metrics : + t

Sum of all reported measurements over a time interval

val histogram_data_point : + ?start_time_unix_nano:Opentelemetry.Timestamp_ns.t -> + ?now:Opentelemetry.Timestamp_ns.t -> + ?attrs: + (string * [< `Bool of bool | `Int of int | `None | `String of string ]) + list -> + ?exemplars:Opentelemetry__Metrics_types.exemplar list -> + ?explicit_bounds:float list -> + ?sum:float -> + bucket_counts:int64 list -> + count:int64 -> + unit -> + Opentelemetry__Metrics_types.histogram_data_point

Histogram data

  • parameter count

    number of values in population (non negative)

  • parameter sum

    sum of values in population (0 if count is 0)

  • parameter bucket_counts

    count value of histogram for each bucket. Sum of the counts must be equal to count. length must be 1+length explicit_bounds

  • parameter explicit_bounds

    strictly increasing list of bounds for the buckets

val histogram : + name:string -> + ?description:string -> + ?unit_:string -> + ?aggregation_temporality:Opentelemetry__Metrics_types.aggregation_temporality -> + Opentelemetry__Metrics_types.histogram_data_point list -> + t
val make_resource_metrics : ?service_name:string -> ?attrs: (string * [< `Bool of bool | `Int of int | `None | `String of string ]) diff --git a/dev/opentelemetry/Opentelemetry/Collector/index.html b/dev/opentelemetry/Opentelemetry/Collector/index.html index f266689f..9000ffa7 100644 --- a/dev/opentelemetry/Opentelemetry/Collector/index.html +++ b/dev/opentelemetry/Opentelemetry/Collector/index.html @@ -1,5 +1,5 @@ -Collector (opentelemetry.Opentelemetry.Collector)

Module Opentelemetry.Collector

Collector types

These types are used by backend implementations, to send events to collectors such as Jaeger.

Note: most users will not need to touch this module

type 'msg sender = {
send : 'a. 'msg -> ret:( unit -> 'a ) -> 'a;
}

Sender interface for a message of type msg. Inspired from Logs' reporter (see its doc) but without over as it doesn't make much sense in presence of batching.

The ret callback is used to return the desired type (unit, or a Lwt promise, or anything else) once the event has been transferred to the backend. It doesn't mean the event has been collected yet, it could sit in a batch queue for a little while.

module type BACKEND = sig ... end

Collector client interface.

type backend = (module BACKEND)
val backend : backend option Stdlib.ref
val has_backend : unit -> bool

Is there a configured backend?

val send_trace : Proto.Trace.resource_spans list -> ret:( unit -> 'a ) -> 'a
val send_metrics : +Collector (opentelemetry.Opentelemetry.Collector)

Module Opentelemetry.Collector

Collector types

These types are used by backend implementations, to send events to collectors such as Jaeger.

Note: most users will not need to touch this module

type 'msg sender = {
send : 'a. 'msg -> ret:( unit -> 'a ) -> 'a;
}

Sender interface for a message of type msg. Inspired from Logs' reporter (see its doc) but without over as it doesn't make much sense in presence of batching.

The ret callback is used to return the desired type (unit, or a Lwt promise, or anything else) once the event has been transferred to the backend. It doesn't mean the event has been collected yet, it could sit in a batch queue for a little while.

module type BACKEND = sig ... end

Collector client interface.

type backend = (module BACKEND)
val set_backend : backend -> unit

Set collector backend

val has_backend : unit -> bool

Is there a configured backend?

val get_backend : unit -> backend option

Current backend, if any

val send_trace : Proto.Trace.resource_spans list -> ret:( unit -> 'a ) -> 'a
val send_metrics : Proto.Metrics.resource_metrics list -> ret:( unit -> 'a ) -> - 'a
val rand_bytes_16 : unit -> bytes
val rand_bytes_8 : unit -> bytes
val tick : unit -> unit

Do background work. Call this regularly if the collector doesn't already have a ticker thread or internal timer.

\ No newline at end of file + 'a
val rand_bytes_16 : unit -> bytes
val rand_bytes_8 : unit -> bytes
val on_tick : ( unit -> unit ) -> unit
val tick : unit -> unit

Do background work. Call this regularly if the collector doesn't already have a ticker thread or internal timer.

\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html b/dev/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html index 4047a28b..b849f288 100644 --- a/dev/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html +++ b/dev/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html @@ -1,2 +1,2 @@ -BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)

Module type Collector.BACKEND

Collector client interface.

val send_trace : Proto.Trace.resource_spans list sender
val send_metrics : Proto.Metrics.resource_metrics list sender
val rand_bytes_16 : unit -> bytes

Generate 16 bytes of random data

val rand_bytes_8 : unit -> bytes

Generate 16 bytes of random data

val signal_emit_gc_metrics : unit -> unit

Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.

val tick : unit -> unit

Should be called regularly for background processing, timeout checks, etc.

val cleanup : unit -> unit
\ No newline at end of file +BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)

Module type Collector.BACKEND

Collector client interface.

val send_trace : Proto.Trace.resource_spans list sender
val send_metrics : Proto.Metrics.resource_metrics list sender
val rand_bytes_16 : unit -> bytes

Generate 16 bytes of random data

val rand_bytes_8 : unit -> bytes

Generate 16 bytes of random data

val signal_emit_gc_metrics : unit -> unit

Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.

val tick : unit -> unit

Should be called regularly for background processing, timeout checks, etc.

val set_on_tick_callbacks : ( unit -> unit ) list Stdlib.ref -> unit

Give the collector the list of callbacks to be executed when tick() is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called on_tick.

val cleanup : unit -> unit
\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Metrics/index.html b/dev/opentelemetry/Opentelemetry/Metrics/index.html index ec96a886..072f2b0f 100644 --- a/dev/opentelemetry/Opentelemetry/Metrics/index.html +++ b/dev/opentelemetry/Opentelemetry/Metrics/index.html @@ -1,5 +1,5 @@ -Metrics (opentelemetry.Opentelemetry.Metrics)

Module Opentelemetry.Metrics

Metrics.

See the spec

type t
val _program_start : Timestamp_ns.t
val float : +Metrics (opentelemetry.Opentelemetry.Metrics)

Module Opentelemetry.Metrics

Metrics.

See the spec

type t

A single metric, measuring some time-varying quantity or statistical distribution. It is composed of one or more data points that have precise values and time stamps. Each distinct metric should have a distinct name.

val float : ?start_time_unix_nano:Timestamp_ns.t -> ?now:Timestamp_ns.t -> ?attrs: @@ -25,7 +25,25 @@ ?aggregation_temporality:aggregation_temporality -> ?is_monotonic:bool -> Opentelemetry__Metrics_types.number_data_point list -> - t

Sum of all reported measurements over a time interval

val make_resource_metrics : + t

Sum of all reported measurements over a time interval

val histogram_data_point : + ?start_time_unix_nano:Timestamp_ns.t -> + ?now:Timestamp_ns.t -> + ?attrs: + (string * [< `Bool of bool | `Int of int | `None | `String of string ]) + list -> + ?exemplars:Opentelemetry__Metrics_types.exemplar list -> + ?explicit_bounds:float list -> + ?sum:float -> + bucket_counts:int64 list -> + count:int64 -> + unit -> + Opentelemetry__Metrics_types.histogram_data_point

Histogram data

  • parameter count

    number of values in population (non negative)

  • parameter sum

    sum of values in population (0 if count is 0)

  • parameter bucket_counts

    count value of histogram for each bucket. Sum of the counts must be equal to count. length must be 1+length explicit_bounds

  • parameter explicit_bounds

    strictly increasing list of bounds for the buckets

val histogram : + name:string -> + ?description:string -> + ?unit_:string -> + ?aggregation_temporality:Opentelemetry__Metrics_types.aggregation_temporality -> + Opentelemetry__Metrics_types.histogram_data_point list -> + t
val make_resource_metrics : ?service_name:string -> ?attrs: (string * [< `Bool of bool | `Int of int | `None | `String of string ]) diff --git a/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html b/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html new file mode 100644 index 00000000..b20df42a --- /dev/null +++ b/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html @@ -0,0 +1,2 @@ + +Metrics_callbacks (opentelemetry.Opentelemetry.Metrics_callbacks)

Module Opentelemetry.Metrics_callbacks

A set of callbacks that produce metrics when called.

The metrics are automatically called regularly.

This allows applications to register metrics callbacks from various points in the program (or even in libraries), and not worry about setting alarms/intervals to emit them.

val register : ( unit -> Metrics.t list ) -> unit

register f adds the callback f to the list. f will be called at unspecified times and is expected to return a list of metrics.

\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Span_id/index.html b/dev/opentelemetry/Opentelemetry/Span_id/index.html index 8d57564e..7f3adf2d 100644 --- a/dev/opentelemetry/Opentelemetry/Span_id/index.html +++ b/dev/opentelemetry/Opentelemetry/Span_id/index.html @@ -1,2 +1,2 @@ -Span_id (opentelemetry.Opentelemetry.Span_id)

Module Opentelemetry.Span_id

Unique ID of a span.

type t
val create : unit -> t
val to_bytes : t -> bytes
val of_bytes : bytes -> t
val to_hex : t -> string
val of_hex : string -> t
\ No newline at end of file +Span_id (opentelemetry.Opentelemetry.Span_id)

Module Opentelemetry.Span_id

Unique ID of a span.

type t
val create : unit -> t
val pp : Stdlib.Format.formatter -> t -> unit
val to_bytes : t -> bytes
val of_bytes : bytes -> t
val to_hex : t -> string
val of_hex : string -> t
\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Trace_id/index.html b/dev/opentelemetry/Opentelemetry/Trace_id/index.html index e3aa7abd..8cfd1a70 100644 --- a/dev/opentelemetry/Opentelemetry/Trace_id/index.html +++ b/dev/opentelemetry/Opentelemetry/Trace_id/index.html @@ -1,2 +1,2 @@ -Trace_id (opentelemetry.Opentelemetry.Trace_id)

Module Opentelemetry.Trace_id

Trace ID.

This 16 bytes identifier is shared by all spans in one trace.

type t
val create : unit -> t
val to_bytes : t -> bytes
val of_bytes : bytes -> t
val to_hex : t -> string
val of_hex : string -> t
\ No newline at end of file +Trace_id (opentelemetry.Opentelemetry.Trace_id)

Module Opentelemetry.Trace_id

Trace ID.

This 16 bytes identifier is shared by all spans in one trace.

type t
val create : unit -> t
val pp : Stdlib.Format.formatter -> t -> unit
val to_bytes : t -> bytes
val of_bytes : bytes -> t
val to_hex : t -> string
val of_hex : string -> t
\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/index.html b/dev/opentelemetry/Opentelemetry/index.html index 183cde47..e0e1e00f 100644 --- a/dev/opentelemetry/Opentelemetry/index.html +++ b/dev/opentelemetry/Opentelemetry/index.html @@ -1,2 +1,2 @@ -Opentelemetry (opentelemetry.Opentelemetry)

Module Opentelemetry

Opentelemetry types and instrumentation

Wire format

module Proto : sig ... end

Protobuf types

Timestamps

module Timestamp_ns : sig ... end

Unix timestamp.

Interface to data collector

module Collector : sig ... end

Collector types

module Util_ : sig ... end

Identifiers

module Trace_id : sig ... end

Trace ID.

module Span_id : sig ... end

Unique ID of a span.

Attributes and conventions

module Conventions : sig ... end
type value = [
| `Int of int
| `String of string
| `Bool of bool
| `None
]
type key_value = string * value

Global settings

module Globals : sig ... end

Process-wide metadata, environment variables, etc.

Traces and Spans

module Event : sig ... end

Events.

module Span : sig ... end

Spans.

module Trace : sig ... end

Traces.

Metrics

module Metrics : sig ... end

Metrics.

module Logs : sig ... end

Utils

module Trace_context : sig ... end

Implementation of the W3C Trace Context spec

module GC_metrics : sig ... end

Export GC metrics.

\ No newline at end of file +Opentelemetry (opentelemetry.Opentelemetry)

Module Opentelemetry

Opentelemetry types and instrumentation

Wire format

module Proto : sig ... end

Protobuf types

Timestamps

module Timestamp_ns : sig ... end

Unix timestamp.

Interface to data collector

module Collector : sig ... end

Collector types

module Util_ : sig ... end

Identifiers

module Trace_id : sig ... end

Trace ID.

module Span_id : sig ... end

Unique ID of a span.

Attributes and conventions

module Conventions : sig ... end
type value = [
| `Int of int
| `String of string
| `Bool of bool
| `None
]
type key_value = string * value

Global settings

module Globals : sig ... end

Process-wide metadata, environment variables, etc.

Traces and Spans

module Event : sig ... end

Events.

module Span : sig ... end

Spans.

module Trace : sig ... end

Traces.

Metrics

module Metrics : sig ... end

Metrics.

module Metrics_callbacks : sig ... end

A set of callbacks that produce metrics when called.

module Logs : sig ... end

Utils

module Trace_context : sig ... end

Implementation of the W3C Trace Context spec

module GC_metrics : sig ... end

Export GC metrics.

\ No newline at end of file