package opentelemetry

You can search for identifiers within the package.

in-package search v0.2.0

package opentelemetry

opentelemetry
- Library opentelemetry
  - Opentelemetry
    
    Lock
    
    Rand_bytes
    
    AList
    
    Proto
    
    Timestamp_ns
    
    Collector
    
    BACKEND
    
    Noop_backend
    
    Debug_backend
    
    Trace_id
    
    Span_id
    
    Span_ctx
    
    Conventions
    
    Attributes
    
    Process
    
    Runtime
    
    Code
    
    Service
    
    HTTP
    
    Host
    
    Metrics
    
    Process
    
    Runtime
    
    Ocaml
    
    GC
    
    HTTP
    
    Server
    
    Client
    
    Globals
    
    Event
    
    Span_link
    
    Span_status
    
    Span_kind
    
    Scope
    
    Span
    
    Trace
    
    Metrics
    
    Metrics_callbacks
    
    Logs
    
    Trace_context
    
    Traceparent
    
    GC_metrics
- Library opentelemetry.ambient-context
  - Opentelemetry_ambient_context
    
    STORAGE
- Library opentelemetry.atomic
  - Opentelemetry_atomic
    
    Atomic
- Library opentelemetry.proto
  - Opentelemetry_proto
    
    Common
    
    Logs
    
    Logs_service
    
    Metrics
    
    Metrics_service
    
    Resource
    
    Status
    
    Trace
    
    Trace_service
- Library opentelemetry_ambient_context_lwt
  - Opentelemetry_ambient_context_lwt
- Library opentelemetry_ambient_context_types
  - Opentelemetry_ambient_context_types
    
    STORAGE
- Sources
  - opentelemetry
    
    AList.ml
    
    lock.ml
    
    opentelemetry.ml
    
    opentelemetry__.ml
    
    rand_bytes.ml
  - opentelemetry.ambient-context
    
    opentelemetry_ambient_context.ml
    
    opentelemetry_ambient_context__.ml
  - opentelemetry.atomic
    
    atomic.ml
    
    opentelemetry_atomic.ml
  - opentelemetry.proto
    
    common.ml
    
    logs.ml
    
    logs_service.ml
    
    metrics.ml
    
    metrics_service.ml
    
    opentelemetry_proto.ml
    
    resource.ml
    
    status.ml
    
    trace.ml
    
    trace_service.ml
  - opentelemetry_ambient_context_lwt
    
    opentelemetry_ambient_context_lwt.ml
  - opentelemetry_ambient_context_types
    
    opentelemetry_ambient_context_types.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Opentelemetry.Scope`Source

Scopes.

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

Sourcetype item_list

Sourcetype t = {

trace_id : Trace_id.t;
span_id : Span_id.t;
mutable items : item_list;

}

Sourceval attrs : t -> key_value list

Sourceval events : t -> Event.t list

Sourceval links : t -> Span_link.t list

Sourceval status : t -> Span_status.t option

Sourceval kind : t -> Span_kind.t option

val make : 
  trace_id:Trace_id.t ->
  span_id:Span_id.t ->
  ?events:Event.t list ->
  ?attrs:key_value list ->
  ?links:Span_link.t list ->
  ?status:Span_status.t ->
  unit ->
  t

val to_span_link : 
  ?trace_state:string ->
  ?attrs:key_value list ->
  ?dropped_attributes_count:int ->
  t ->
  Span_link.t

Turn the scope into a span link

Sourceval to_span_ctx : t -> Span_ctx.t

Turn the scope into a span context

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

Sourceval record_exception : t -> exn -> Printexc.raw_backtrace -> unit

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

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

Sourceval add_links : t -> (unit -> Span_link.t list) -> unit

Add links to the scope. It will be aggregated into the span.

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

Sourceval set_status : t -> Span_status.t -> unit

set the span status.

Note that this function will be called only if there is an instrumentation backend.

Sourceval set_kind : t -> Span_kind.t -> unit

Set the span's kind.

since NEXT_RELEASE

Sourceval ambient_scope_key : t Ambient_context.key

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

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

Obtain current scope from Ambient_context, if available.

Sourceval 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