package opentelemetry

You can search for identifiers within the package.

in-package search v0.2.0

opentelemetry
- Opentelemetry
  - AList
  - Collector
    
    BACKEND
    
    Debug_backend
    
    B
    
    Noop_backend
  - Conventions
    
    Attributes
    
    Code
    
    HTTP
    
    Process
    
    Runtime
    
    Service
    
    Metrics
    
    HTTP
    
    Client
    
    Server
    
    Process
    
    Runtime
    
    Ocaml
    
    GC
  - Event
  - GC_metrics
  - Globals
  - Lock
  - Logs
  - Metrics
  - Metrics_callbacks
  - Rand_bytes
  - Scope
  - Span
  - Span_ctx
  - Span_id
  - Span_link
  - Timestamp_ns
  - Trace
  - Trace_context
    
    Traceparent
  - Trace_id
opentelemetry.atomic
- Opentelemetry_atomic
  - Atomic
opentelemetry.proto
- Opentelemetry_proto
  - Common
  - Logs
  - Logs_service
  - Metrics
  - Metrics_service
  - Resource
  - Status
  - Trace
  - Trace_service

Legend:
Library
Module
Module type
Parameter
Class
Class type

Scopes.

A scope is a trace ID and the span ID of the currently active span.

type t = {

trace_id : Trace_id.t;
span_id : Span_id.t;
mutable events : Event.t list;
mutable attrs : key_value list;

}

val to_span_ctx : t -> Span_ctx.t

Turn the scope into a span context

val add_event : t -> (unit -> Event.t) -> unit

Add an event to the scope. It will be aggregated into the span.

Note that this takes a function that produces an event, and will only call it if there is an instrumentation backend.

val add_attrs : t -> (unit -> key_value list) -> unit

Add an attr to the scope. It will be aggregated into the span.

Note that this takes a function that produces attributes, and will only call it if there is an instrumentation backend.

val ambient_scope_key : t Ambient_context.key

The opaque key necessary to access/set the ambient scope with Ambient_context.

val get_ambient_scope : ?scope:t -> unit -> t option

Obtain current scope from Ambient_context, if available.

val with_ambient_scope : t -> (unit -> 'a) -> 'a

with_ambient_scope sc thunk calls thunk() in a context where sc is the (thread|continuation)-local scope, then reverts to the previous local scope, if any.

see https://github.com/ELLIOTTCABLE/ocaml-ambient-context
ambient-context docs