diff --git a/dev/index.html b/dev/index.html index 3ed9f87e..0685b3cf 100644 --- a/dev/index.html +++ b/dev/index.html @@ -11,6 +11,7 @@

OCaml package documentation

    +
  1. atomic 0.1
  2. opentelemetry
  3. opentelemetry-client-ocurl
  4. opentelemetry-lwt
    5. diff --git a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html new file mode 100644 index 00000000..a61c0332 --- /dev/null +++ b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html @@ -0,0 +1,10 @@ + +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

    *)
    }
    val make : + ?debug:bool -> + ?url:string -> + ?batch_traces:int option -> + ?batch_metrics:int option -> + ?batch_timeout_ms:int -> + ?thread:bool -> + unit -> + t

    Make a configuration

    val pp : Stdlib.Format.formatter -> t -> unit
    \ No newline at end of file diff --git a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html index 6927af28..ef20ffe0 100644 --- a/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html +++ b/dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html @@ -1,2 +1,7 @@ -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
    val setup : unit -> unit

    Setup endpoint. This modifies Opentelemetry.Collector.backend.

    val with_setup : ( unit -> 'a ) -> 'a
    \ No newline at end of file +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 : + ?config:Config.t -> + ?enable:bool -> + unit -> + ( unit -> 'a ) -> + 'a

    with_setup () f is like setup(); f() but takes care of cleaning up after f() returns.

    \ No newline at end of file diff --git a/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html b/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html index b106e97a..b3d0a6ff 100644 --- a/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html +++ b/dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html @@ -19,4 +19,6 @@ ?aggregation_temporality:Opentelemetry__Metrics_types.aggregation_temporality -> ?is_monotonic:bool -> Opentelemetry__Metrics_types.number_data_point list -> - t

Sum of all reported measurements over a time interval

val emit : t list -> unit Lwt.t

Emit some metrics to the collector.

\ No newline at end of file + t

Sum of all reported measurements over a time interval

val make_resource_metrics : + t list -> + Opentelemetry__Metrics_types.resource_metrics

Aggregate metrics into a Proto.Metrics.resource_metrics

val emit : t list -> unit Lwt.t

Emit some metrics to the collector.

\ 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 4dbf0d9e..05fdd4c8 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 rand_bytes_16 : unit -> bytes

Generate 16 bytes of random data

val rand_bytes_8 : unit -> bytes

Generate 16 bytes of random data

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 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 fa23d304..f908701d 100644 --- a/dev/opentelemetry/Opentelemetry/Metrics/index.html +++ b/dev/opentelemetry/Opentelemetry/Metrics/index.html @@ -19,4 +19,6 @@ ?aggregation_temporality:Opentelemetry__Metrics_types.aggregation_temporality -> ?is_monotonic:bool -> Opentelemetry__Metrics_types.number_data_point list -> - t

Sum of all reported measurements over a time interval

val emit : t list -> unit

Emit some metrics to the collector (sync).

\ No newline at end of file + t

Sum of all reported measurements over a time interval

val make_resource_metrics : + t list -> + Opentelemetry__Metrics_types.resource_metrics

Aggregate metrics into a Proto.Metrics.resource_metrics

val emit : t list -> unit

Emit some metrics to the collector (sync).

\ No newline at end of file