package opentelemetry

  1. Overview
  2. Docs
Core library for instrumentation and serialization for https://opentelemetry.io

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (17)

Authors

  1. O
    ocaml-tracing
  2. E
    ELLIOTTCABLE <opam@ell.io>
  3. T
    the imandra team

Maintainers

  1. O
    ocaml-tracing

Sources

opentelemetry-0.91.tbz
sha256=4aaee2025957acf71434a027bd57ee699a9ae927e6b49804fb1e999e16a03694
sha512=f3ec030fc4ca0483c3fc143eaa802e2aa02b4c25e1a03ec967bd017fad8a4ef6287e9f9688486434d1ac2fc403217658b61d2c7f3709c092c939b93f412ee5c5

doc/opentelemetry/Opentelemetry/Collector/index.html

Module Opentelemetry.CollectorSource

  • deprecated Use 'Exporter' instead
include module type of struct include Exporter end
include module type of struct include Opentelemetry_core.Exporter end
Sourcetype t = Opentelemetry_core.Exporter.t = {
  1. export : Opentelemetry_core.Any_signal_l.t -> unit;
    (*

    Export a batch of signals. Called by the provider when signals are ready to be sent.

    *)
  2. active : unit -> Opentelemetry_util.Aswitch.t;
    (*

    Lifecycle switch: turns off when the exporter has fully shut down (i.e. the consumer queue is drained).

    *)
  3. shutdown : unit -> unit;
    (*

    shutdown () initiates shutdown: flushes remaining batches, closes the queue, etc. Watch active to know when it's complete.

    • since 0.12
    *)
  4. self_metrics : unit -> Opentelemetry_core.Metrics.t list;
    (*

    metrics about the exporter itself

    *)
}

Main exporter interface.

Sourceval dummy : unit -> t

Dummy exporter, does nothing

Sourceval shutdown : t -> unit
Sourceval cleanup : t -> unit
include module type of struct include Sdk end
include module type of struct include Sdk end
Sourceval remove : on_done:(unit -> unit) -> unit -> unit

Remove current exporter, if any.

  • parameter on_done

    called once the exporter has fully shut down (queue drained).

Sourceval present : unit -> bool
Sourceval get : unit -> Opentelemetry_core.Exporter.t option

Aswitch of the installed exporter, or Aswitch.dummy if none.

Sourceval add_on_tick_callback : (unit -> unit) -> unit
Sourceval run_tick_callbacks : unit -> unit
Sourceval tick : unit -> unit

Tick all providers and run all registered callbacks. Call this periodically (e.g. every 500ms) to drive metrics collection, GC metrics, and batch timeout flushing. This is the single function client libraries should call from their ticker.

Sourceval set : ?traces:??? -> ?metrics:??? -> ?logs:??? -> Opentelemetry_core.Exporter.t -> unit
Sourceval self_metrics : unit -> Opentelemetry_core.Metrics.t list
Sourceval setup_self_metrics : unit -> unit

Regularly emit metrics about the OTEL SDK. Idempotent.

Sourceval get_tracer : ?name:??? -> ?version:??? -> ?attrs:??? -> ?__MODULE__:??? -> unit -> Tracer.t

Get a tracer forwarding to the current main exporter.

  • since 0.90
Sourceval get_meter : ?name:??? -> ?version:??? -> ?attrs:??? -> ?__MODULE__:??? -> unit -> Meter.t

Get a meter forwarding to the current main exporter.

  • since 0.90
Sourceval get_logger : ?name:??? -> ?version:??? -> ?attrs:??? -> ?__MODULE__:??? -> unit -> Logger.t

Get a logger forwarding to the current main exporter.

  • since 0.90
Sourceval self_debug_to_stderr : ?min_level:??? -> unit -> unit