package opentelemetry

You can search for identifiers within the package.

in-package search v0.2.0

opentelemetry
- Opentelemetry
  - Collector
    
    BACKEND
  - Conventions
    
    Attributes
    
    Process
    
    Runtime
    
    Service
    
    Metrics
    
    Process
    
    Runtime
    
    Ocaml
    
    GC
  - Event
  - GC_metrics
  - Globals
  - Lock
  - Logs
  - Metrics
  - Metrics_callbacks
  - Proto
    
    Common
    
    Logs
    
    Logs_service
    
    Metrics
    
    Metrics_service
    
    Resource
    
    Status
    
    Trace
    
    Trace_service
  - Rand_bytes
  - Scope
  - Span
  - Span_id
  - Span_link
  - Thread_local
  - Timestamp_ns
  - Trace
  - Trace_context
    
    Traceparent
  - Trace_id
  - Util_
opentelemetry.atomic
- Opentelemetry_atomic
  - Atomic

Legend:
Library
Module
Module type
Parameter
Class
Class type

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 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.