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 9919534a..8301883b 100644 --- a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html +++ b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html @@ -1,10 +1,11 @@ -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 : +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_logs : int option;(*

Batch logs? See batch_metrics for details. Default Some 400

*)
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_logs:int option -> ?batch_timeout_ms:int -> ?thread:bool -> ?ticker_thread:bool -> diff --git a/dev/opentelemetry/Opentelemetry/Collector/index.html b/dev/opentelemetry/Opentelemetry/Collector/index.html index 9000ffa7..ab1256d7 100644 --- a/dev/opentelemetry/Opentelemetry/Collector/index.html +++ b/dev/opentelemetry/Opentelemetry/Collector/index.html @@ -2,4 +2,4 @@ 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 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 + 'a
val send_logs : Proto.Logs.resource_logs list -> ret:( unit -> 'a ) -> '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 760e465c..b506119e 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 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 +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 send_logs : Proto.Logs.resource_logs list sender
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/Logs/index.html b/dev/opentelemetry/Opentelemetry/Logs/index.html index 45c6210c..d7ce445c 100644 --- a/dev/opentelemetry/Opentelemetry/Logs/index.html +++ b/dev/opentelemetry/Opentelemetry/Logs/index.html @@ -1,2 +1,41 @@ -Logs (opentelemetry.Opentelemetry.Logs)

Module Opentelemetry.Logs

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

Module Opentelemetry.Logs

Logs.

See the spec

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.

type t
type severity =
| Severity_number_unspecified
| Severity_number_trace
| Severity_number_trace2
| Severity_number_trace3
| Severity_number_trace4
| Severity_number_debug
| Severity_number_debug2
| Severity_number_debug3
| Severity_number_debug4
| Severity_number_info
| Severity_number_info2
| Severity_number_info3
| Severity_number_info4
| Severity_number_warn
| Severity_number_warn2
| Severity_number_warn3
| Severity_number_warn4
| Severity_number_error
| Severity_number_error2
| Severity_number_error3
| Severity_number_error4
| Severity_number_fatal
| Severity_number_fatal2
| Severity_number_fatal3
| Severity_number_fatal4

Severity level of a log event

val pp_severity : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.severity_number -> + unit
type flags =
| Log_record_flag_unspecified
| Log_record_flag_trace_flags_mask
val pp_flags : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.log_record_flags -> + unit
val make : + ?time:Timestamp_ns.t -> + ?observed_time_unix_nano:Timestamp_ns.t -> + ?severity:Opentelemetry__Logs_types.severity_number -> + ?log_level:string -> + ?flags:int32 -> + ?trace_id:Trace_id.t -> + ?span_id:Span_id.t -> + value -> + t

Make a single log entry

val make_str : + ?time:Timestamp_ns.t -> + ?observed_time_unix_nano:Timestamp_ns.t -> + ?severity:Opentelemetry__Logs_types.severity_number -> + ?log_level:string -> + ?flags:int32 -> + ?trace_id:Trace_id.t -> + ?span_id:Span_id.t -> + string -> + t

Make a log entry whose body is a string

val make_strf : + ?time:Timestamp_ns.t -> + ?observed_time_unix_nano:Timestamp_ns.t -> + ?severity:Opentelemetry__Logs_types.severity_number -> + ?log_level:string -> + ?flags:int32 -> + ?trace_id:Trace_id.t -> + ?span_id:Span_id.t -> + ( 'a, Stdlib.Format.formatter, unit, t ) Stdlib.format4 -> + 'a

Make a log entry with format

val emit : + ?service_name:string -> + ?attrs: + (string * [< `Bool of bool | `Int of int | `None | `String of string ]) + list -> + t list -> + unit
\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html b/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html index b20df42a..38d489e2 100644 --- a/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html +++ b/dev/opentelemetry/Opentelemetry/Metrics_callbacks/index.html @@ -1,2 +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 +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/Proto/Logs/index.html b/dev/opentelemetry/Opentelemetry/Proto/Logs/index.html new file mode 100644 index 00000000..8f38d682 --- /dev/null +++ b/dev/opentelemetry/Opentelemetry/Proto/Logs/index.html @@ -0,0 +1,71 @@ + +Logs (opentelemetry.Opentelemetry.Proto.Logs)

Module Proto.Logs

Types

type severity_number =
| Severity_number_unspecified
| Severity_number_trace
| Severity_number_trace2
| Severity_number_trace3
| Severity_number_trace4
| Severity_number_debug
| Severity_number_debug2
| Severity_number_debug3
| Severity_number_debug4
| Severity_number_info
| Severity_number_info2
| Severity_number_info3
| Severity_number_info4
| Severity_number_warn
| Severity_number_warn2
| Severity_number_warn3
| Severity_number_warn4
| Severity_number_error
| Severity_number_error2
| Severity_number_error3
| Severity_number_error4
| Severity_number_fatal
| Severity_number_fatal2
| Severity_number_fatal3
| Severity_number_fatal4
type log_record = {
time_unix_nano : int64;
observed_time_unix_nano : int64;
severity_number : severity_number;
severity_text : string;
name : string;
body : Opentelemetry__Common_types.any_value option;
attributes : Opentelemetry__Common_types.key_value list;
dropped_attributes_count : int32;
flags : int32;
trace_id : bytes;
span_id : bytes;
}
type instrumentation_library_logs = {
instrumentation_library : Opentelemetry__Common_types.instrumentation_library + option;
log_records : log_record list;
schema_url : string;
}
type resource_logs = {
resource : Opentelemetry__Resource_types.resource option;
instrumentation_library_logs : instrumentation_library_logs list;
schema_url : string;
}
type logs_data = {
resource_logs : resource_logs list;
}
type log_record_flags =
| Log_record_flag_unspecified
| Log_record_flag_trace_flags_mask

Default values

val default_severity_number : unit -> severity_number

default_severity_number () is the default value for type severity_number

val default_log_record : + ?time_unix_nano:int64 -> + ?observed_time_unix_nano:int64 -> + ?severity_number:severity_number -> + ?severity_text:string -> + ?name:string -> + ?body:Opentelemetry__Common_types.any_value option -> + ?attributes:Opentelemetry__Common_types.key_value list -> + ?dropped_attributes_count:int32 -> + ?flags:int32 -> + ?trace_id:bytes -> + ?span_id:bytes -> + unit -> + log_record

default_log_record () is the default value for type log_record

val default_instrumentation_library_logs : + ?instrumentation_library: + Opentelemetry__Common_types.instrumentation_library option -> + ?log_records:log_record list -> + ?schema_url:string -> + unit -> + instrumentation_library_logs

default_instrumentation_library_logs () is the default value for type instrumentation_library_logs

val default_resource_logs : + ?resource:Opentelemetry__Resource_types.resource option -> + ?instrumentation_library_logs:instrumentation_library_logs list -> + ?schema_url:string -> + unit -> + resource_logs

default_resource_logs () is the default value for type resource_logs

val default_logs_data : ?resource_logs:resource_logs list -> unit -> logs_data

default_logs_data () is the default value for type logs_data

val default_log_record_flags : unit -> log_record_flags

default_log_record_flags () is the default value for type log_record_flags

Protobuf Encoding

val encode_severity_number : + Opentelemetry__Logs_types.severity_number -> + Pbrt.Encoder.t -> + unit

encode_severity_number v encoder encodes v with the given encoder

val encode_log_record : + Opentelemetry__Logs_types.log_record -> + Pbrt.Encoder.t -> + unit

encode_log_record v encoder encodes v with the given encoder

val encode_instrumentation_library_logs : + Opentelemetry__Logs_types.instrumentation_library_logs -> + Pbrt.Encoder.t -> + unit

encode_instrumentation_library_logs v encoder encodes v with the given encoder

val encode_resource_logs : + Opentelemetry__Logs_types.resource_logs -> + Pbrt.Encoder.t -> + unit

encode_resource_logs v encoder encodes v with the given encoder

val encode_logs_data : + Opentelemetry__Logs_types.logs_data -> + Pbrt.Encoder.t -> + unit

encode_logs_data v encoder encodes v with the given encoder

val encode_log_record_flags : + Opentelemetry__Logs_types.log_record_flags -> + Pbrt.Encoder.t -> + unit

encode_log_record_flags v encoder encodes v with the given encoder

Protobuf Decoding

val decode_severity_number : + Pbrt.Decoder.t -> + Opentelemetry__Logs_types.severity_number

decode_severity_number decoder decodes a severity_number value from decoder

val decode_log_record : Pbrt.Decoder.t -> Opentelemetry__Logs_types.log_record

decode_log_record decoder decodes a log_record value from decoder

val decode_instrumentation_library_logs : + Pbrt.Decoder.t -> + Opentelemetry__Logs_types.instrumentation_library_logs

decode_instrumentation_library_logs decoder decodes a instrumentation_library_logs value from decoder

val decode_resource_logs : + Pbrt.Decoder.t -> + Opentelemetry__Logs_types.resource_logs

decode_resource_logs decoder decodes a resource_logs value from decoder

val decode_logs_data : Pbrt.Decoder.t -> Opentelemetry__Logs_types.logs_data

decode_logs_data decoder decodes a logs_data value from decoder

val decode_log_record_flags : + Pbrt.Decoder.t -> + Opentelemetry__Logs_types.log_record_flags

decode_log_record_flags decoder decodes a log_record_flags value from decoder

Formatters

val pp_severity_number : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.severity_number -> + unit

pp_severity_number v formats v

val pp_log_record : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.log_record -> + unit

pp_log_record v formats v

val pp_instrumentation_library_logs : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.instrumentation_library_logs -> + unit

pp_instrumentation_library_logs v formats v

val pp_resource_logs : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.resource_logs -> + unit

pp_resource_logs v formats v

val pp_logs_data : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.logs_data -> + unit

pp_logs_data v formats v

val pp_log_record_flags : + Stdlib.Format.formatter -> + Opentelemetry__Logs_types.log_record_flags -> + unit

pp_log_record_flags v formats v

\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Proto/Logs_service/index.html b/dev/opentelemetry/Opentelemetry/Proto/Logs_service/index.html new file mode 100644 index 00000000..616da90e --- /dev/null +++ b/dev/opentelemetry/Opentelemetry/Proto/Logs_service/index.html @@ -0,0 +1,13 @@ + +Logs_service (opentelemetry.Opentelemetry.Proto.Logs_service)

Module Proto.Logs_service

Types

type export_logs_service_request = {
resource_logs : Opentelemetry__Logs_types.resource_logs list;
}

Default values

val default_export_logs_service_request : + ?resource_logs:Opentelemetry__Logs_types.resource_logs list -> + unit -> + export_logs_service_request

default_export_logs_service_request () is the default value for type export_logs_service_request

Protobuf Encoding

val encode_export_logs_service_request : + Opentelemetry__Logs_service_types.export_logs_service_request -> + Pbrt.Encoder.t -> + unit

encode_export_logs_service_request v encoder encodes v with the given encoder

Protobuf Decoding

val decode_export_logs_service_request : + Pbrt.Decoder.t -> + Opentelemetry__Logs_service_types.export_logs_service_request

decode_export_logs_service_request decoder decodes a export_logs_service_request value from decoder

Formatters

val pp_export_logs_service_request : + Stdlib.Format.formatter -> + Opentelemetry__Logs_service_types.export_logs_service_request -> + unit

pp_export_logs_service_request v formats v

\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/Proto/index.html b/dev/opentelemetry/Opentelemetry/Proto/index.html index bc9145f4..ffdf4884 100644 --- a/dev/opentelemetry/Opentelemetry/Proto/index.html +++ b/dev/opentelemetry/Opentelemetry/Proto/index.html @@ -1,2 +1,2 @@ -Proto (opentelemetry.Opentelemetry.Proto)

Module Opentelemetry.Proto

Protobuf types

module Common : sig ... end
module Resource : sig ... end
module Trace : sig ... end
module Metrics : sig ... end
module Trace_service : sig ... end
module Metrics_service : sig ... end
module Status : sig ... end
\ No newline at end of file +Proto (opentelemetry.Opentelemetry.Proto)

Module Opentelemetry.Proto

Protobuf types

module Common : sig ... end
module Resource : sig ... end
module Trace : sig ... end
module Metrics : sig ... end
module Trace_service : sig ... end
module Metrics_service : sig ... end
module Status : sig ... end
module Logs : sig ... end
module Logs_service : sig ... end
\ No newline at end of file diff --git a/dev/opentelemetry/Opentelemetry/index.html b/dev/opentelemetry/Opentelemetry/index.html index 129d04ad..fb228787 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

module Lock : sig ... end

Global lock

module Rand_bytes : sig ... end

Generation of random identifiers

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 +Opentelemetry (opentelemetry.Opentelemetry)

Module Opentelemetry

Opentelemetry types and instrumentation

module Lock : sig ... end

Global lock

module Rand_bytes : sig ... end

Generation of random identifiers

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

Logs.

module Metrics_callbacks : sig ... end

A set of callbacks that produce metrics when called. The metrics are automatically called regularly.

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