diff --git a/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html b/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html index 5fd69ded..2d6d8460 100644 --- a/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html +++ b/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html @@ -1,5 +1,5 @@ -Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)

Module Opentelemetry_client_ocurl.Config

Configuration for the ocurl backend

type t = {
  1. bg_threads : int;
    (*

    Are there background threads, and how many? Default 4. This will be adjusted to be at least 1 and at most 32.

    *)
  2. ticker_thread : bool;
    (*

    If true, start a thread that regularly checks if signals should be sent to the collector. Default true

    *)
  3. ticker_interval_ms : int;
    (*

    Interval for ticker thread, in milliseconds. This is only useful if ticker_thread is true. This will be clamped between 2 ms and some longer interval (maximum 60s currently). Default 500.

    • since 0.7
    *)
  4. common : Opentelemetry_client.Config.t;
    (*

    Common configuration options

    • since NEXT_RELEASE
    *)
}

Configuration.

To build one, use make below. This might be extended with more fields in the future.

val pp : Stdlib.Format.formatter -> t -> unit
val make : +Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)

Module Opentelemetry_client_ocurl.Config

Configuration for the ocurl backend

type t = {
  1. bg_threads : int;
    (*

    Are there background threads, and how many? Default 4. This will be adjusted to be at least 1 and at most 32.

    *)
  2. ticker_thread : bool;
    (*

    If true, start a thread that regularly checks if signals should be sent to the collector. Default true

    *)
  3. ticker_interval_ms : int;
    (*

    Interval for ticker thread, in milliseconds. This is only useful if ticker_thread is true. This will be clamped between 2 ms and some longer interval (maximum 60s currently). Default 500.

    • since 0.7
    *)
  4. common : Opentelemetry_client.Config.t;
    (*

    Common configuration options

    • since 0.12
    *)
}

Configuration.

To build one, use make below. This might be extended with more fields in the future.

val pp : Stdlib.Format.formatter -> t -> unit
val make : (?bg_threads:int -> ?ticker_thread:bool -> ?ticker_interval_ms:int -> diff --git a/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html b/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html index 136aefa6..994f1b98 100644 --- a/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html +++ b/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html @@ -8,7 +8,7 @@ ?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

  • parameter stop

    an atomic boolean. When it becomes true, background threads will all stop after a little while.

val remove_backend : unit -> unit
  • since NEXT_RELEASE
val with_setup : + 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

  • parameter stop

    an atomic boolean. When it becomes true, background threads will all stop after a little while.

val remove_backend : unit -> unit
  • since 0.12
val with_setup : ?stop:bool Atomic.t -> ?config:Config.t -> ?enable:bool -> diff --git a/opentelemetry/Opentelemetry/Collector/Debug_backend/argument-1-B/index.html b/opentelemetry/Opentelemetry/Collector/Debug_backend/argument-1-B/index.html index e130394c..08bf157f 100644 --- a/opentelemetry/Opentelemetry/Collector/Debug_backend/argument-1-B/index.html +++ b/opentelemetry/Opentelemetry/Collector/Debug_backend/argument-1-B/index.html @@ -1,2 +1,2 @@ -B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)

Parameter Debug_backend.B

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done. since NEXT_RELEASE

+B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)

Parameter Debug_backend.B

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done.

    @since 0.12

diff --git a/opentelemetry/Opentelemetry/Collector/Debug_backend/index.html b/opentelemetry/Opentelemetry/Collector/Debug_backend/index.html index 9c7dc55b..2da110f1 100644 --- a/opentelemetry/Opentelemetry/Collector/Debug_backend/index.html +++ b/opentelemetry/Opentelemetry/Collector/Debug_backend/index.html @@ -1,2 +1,2 @@ -Debug_backend (opentelemetry.Opentelemetry.Collector.Debug_backend)

Module Collector.Debug_backend

Parameters

module B : BACKEND

Signature

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done. since NEXT_RELEASE

+Debug_backend (opentelemetry.Opentelemetry.Collector.Debug_backend)

Module Collector.Debug_backend

Parameters

module B : BACKEND

Signature

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done.

    @since 0.12

diff --git a/opentelemetry/Opentelemetry/Collector/Noop_backend/index.html b/opentelemetry/Opentelemetry/Collector/Noop_backend/index.html index 8998061f..c005bcc8 100644 --- a/opentelemetry/Opentelemetry/Collector/Noop_backend/index.html +++ b/opentelemetry/Opentelemetry/Collector/Noop_backend/index.html @@ -1,2 +1,2 @@ -Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)

Module Collector.Noop_backend

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done. since NEXT_RELEASE

+Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)

Module Collector.Noop_backend

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done.

    @since 0.12

diff --git a/opentelemetry/Opentelemetry/Collector/index.html b/opentelemetry/Opentelemetry/Collector/index.html index 22f1971c..b340ffa4 100644 --- a/opentelemetry/Opentelemetry/Collector/index.html +++ b/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 = {
  1. 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 debug_backend : backend
val set_backend : backend -> unit

Set collector backend

val remove_backend : on_done:(unit -> unit) -> unit -> unit

Remove current backend, if any.

  • since 0.11
val has_backend : unit -> bool

Is there a configured backend?

val get_backend : unit -> backend option

Current backend, if any

val send_trace : +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 = {
  1. 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 debug_backend : backend
val set_backend : backend -> unit

Set collector backend

val remove_backend : on_done:(unit -> unit) -> unit -> unit

Remove current backend, if any.

  • since 0.11
val has_backend : unit -> bool

Is there a configured backend?

val get_backend : unit -> backend option

Current backend, if any

val send_trace : Opentelemetry_proto.Trace.resource_spans list -> ret:(unit -> 'a) -> 'a
val send_metrics : diff --git a/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html b/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html index 3efd0dd8..46d54d85 100644 --- a/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html +++ b/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 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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done. since NEXT_RELEASE

+BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)

Module type Collector.BACKEND

Collector client interface.

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) AList.t -> 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 : on_done:(unit -> unit) -> unit -> unit

cleanup ~on_done () is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.

  • parameter on_done

    callback invoked after the cleanup is done.

    @since 0.12

diff --git a/opentelemetry/Opentelemetry/Globals/index.html b/opentelemetry/Opentelemetry/Globals/index.html index 83bd7a4f..38a16af5 100644 --- a/opentelemetry/Opentelemetry/Globals/index.html +++ b/opentelemetry/Opentelemetry/Globals/index.html @@ -1,5 +1,5 @@ -Globals (opentelemetry.Opentelemetry.Globals)

Module Opentelemetry.Globals

Process-wide metadata, environment variables, etc.

val service_name : string ref

Main service name metadata

val service_namespace : string option ref

Namespace for the service

val service_instance_id : string option ref

Unique identifier for the service

val service_version : string option ref

Version for the service

  • since NEXT_RELEASE
val instrumentation_library : Proto.Common.instrumentation_scope
val global_attributes : Proto.Common.key_value list ref

Global attributes, initially set via OTEL_RESOURCE_ATTRIBUTES and modifiable by the user code. They will be attached to each outgoing metrics/traces.

val add_global_attribute : string -> value -> unit

Add a global attribute

val merge_global_attributes_ : +Globals (opentelemetry.Opentelemetry.Globals)

Module Opentelemetry.Globals

Process-wide metadata, environment variables, etc.

val service_name : string ref

Main service name metadata

val service_namespace : string option ref

Namespace for the service

val service_instance_id : string option ref

Unique identifier for the service

val service_version : string option ref

Version for the service

  • since 0.12
val instrumentation_library : Proto.Common.instrumentation_scope
val global_attributes : Proto.Common.key_value list ref

Global attributes, initially set via OTEL_RESOURCE_ATTRIBUTES and modifiable by the user code. They will be attached to each outgoing metrics/traces.

val add_global_attribute : string -> value -> unit

Add a global attribute

val merge_global_attributes_ : Proto.Common.key_value list -> Proto.Common.key_value list
val default_span_kind : Proto.Trace.span_span_kind ref

Default span kind in Span.create. This will be used in all spans that do not specify ~kind explicitly; it is set to "internal", following directions from the .proto file. It can be convenient to set "client" or "server" uniformly in here.

  • since 0.4
val mk_attributes : ?service_name:string ->