API Reference opentelemetry_api v1.0.3

Modules

An OpenTelemetry Trace consists of 1 or more Spans that either have a parent/child relationship or are linked together through a Link. Each Span has a TraceId (trace_id/0), SpanId (span_id/0), and a start and end time in nanoseconds.

Baggage is used to annotate telemetry, adding context and information to metrics, traces, and logs. It is represented by a set of name/value pairs describing user-defined properties.

Ctx is responsible for propagating values within a process that are associated with a particular Trace or set of Baggage. OpenTelemetry.Tracer and OpenTelemetry.Baggage handle updating the Context.

This module contains macros for Span operations that update the active current Span in the current process. An example of creating an Event and adding it to the current Span

This module contains macros for Tracer operations around the lifecycle of the Spans within a Trace.

The types defined here, and referencing records in opentelemetry.hrl are used to store trace information while being collected on the Erlang node.

Baggage is used to annotate telemetry, adding context and information to metrics, traces, and logs. It is represented by a set of name/value pairs describing user-defined properties.
Ctx is responsible for propagating values within a process that are associated with a particular Trace or set of Baggage. OpenTelemetry.Tracer and OpenTelemetry.Baggage handle updating the Context.

A Propagator injects or extracts data from a Context so information like baggage and trace context can be transported along with cross service requests, like an HTTP request.

An implementation of otel_propagator_text_map that injects and extracts trace context using the B3 specification from Zipkin.

An implementation of otel_propagator_text_map that injects and extracts trace context using the B3 multi header format specification from Zipkin.

See also: otel_propagator_b3.

An implementation of otel_propagator_text_map that injects and extracts trace context using the B3 single header format specification from Zipkin.

See also: otel_propagator_b3.

An implementation of otel_propagator_text_map that injects and extracts baggage using the W3C Baggage format.

A TextMap Propagator is a Propagator that performs injection and extraction with ASCII keys and values.

A Composite TextMap Propagator is a Propagator that performs run multiple TextMap Propagators in a specified order.

This noop TextMap Propagator makes no changes to the context or the carrier when doing an extract or inject call. '''

An implementation of otel_propagator_text_map that injects and extracts trace context using the W3C TraceContext format.

Span behaviour.
This module defines the API for a TracerProvider. A TracerProvider stores Tracer configuration and is how Tracers are accessed. An implementation must be a gen_server that handles the API's calls. The SDK should register a TracerProvider with the name otel_tracer_provider which is used as the default global Provider.