OpenTelemetrySDK

ConsoleExporter(;io=stdout)

Print an AbstractSpan or Metric into io.

InMemoryExporter(;pool=[], is_closed=false)

Simply store all export!ed elements into the pool.

TracerProvider(;kw...)

Keyword Arguments

• sampler::AbstractSampler=DEFAULT_ON
• resource=Resource()
• span_processor::AbstractSpanProcessor=SimpleSpanProcessor(ConsoleExporter)
• id_generator::AbstractIdGenerator=RandomIdGenerator()
• limit_info=LimitInfo()

The following extra methods are provided beyond those defined in AbstractTracerProvider:

• flush(p::TracerProvider)
• close(p::TracerProvider)
• Base.push!(p::TracerProvider, sp::AbstractSpanProcessor)

RandomIdGenerator(rng=Random.GLOBAL_RNG)

Use the rng to generate a random trace id or span id.

Always drop the span.

Always sample the span.

Sampler that respects its parent span's sampling decision, but otherwise never samples.

Sampler that respects its parent span's sampling decision, but otherwise always samples.

BatchSpanProcessor(exporter;kw...)

Keyword arguments

• max_queue_size
• scheduled_delay_millis
• export_timeout_millis
• max_export_batch_size

The default values of above keyword arugments are read from corresponding environment variables.

CompositSpanProcessor(processors...)

A wrapper of different concrete span processors. Users can also push! new span processors into it after construction. See also SimpleSpanProcessor.

SimpleSpanProcessor(exporter)

Export each span immediately when on_end! is called on this processor.

All measurement will be dropped.

Exemplar(;kw...)

Exemplars are example data points for aggregated data. Read the specification to understand its relation to trace and metric.

Keyword arguments:

• value
• time_unix_nano
• filtered_attributes, extra attributes of a Measurement that are not included in a Metric's :attribute_keys field.
• trace_id, the trace_id in the span context when the measurement happens.
• span_id, the span_id in the span context when the measurement happens.

HistogramAgg(args...)

Arguments:

• boundaries::NTuple{M, Float64} where M, the boundaries to calculate histogram buckets. Note that -Inf and Inf shouldn't be included.
• is_record_min
• is_record_max
• agg_store
• exemplar_reservoir_factory, when set to nothing, no exemplar will be stored.

HistogramAgg{T}(;boundaries = DEFAULT_HISTOGRAM_BOUNDARIES, is_record_min = true, is_record_max = true)

LastValueAgg(agg_store::AggregationStore, exemplar_reservoir_factory)

When exemplar_reservoir_factory set to nothing, no exemplar will be stored.

See more details in the specification.

LastValueAgg{T}()

SumAgg(agg_store::AggregationStore, exemplar_reservoir_factory)

When exemplar_reservoir_factory set to nothing, no exemplar will be stored. See more details in the specification.

SumAgg{T}()

MeterProvider(;resource = Resource(), views = View[], max_metrics = nothing)

If views is empty, a default one (View(;instrument_name="*")) will be added to enable all metrics.

metrics([global_meter_provider()])

View(name=nothing;kwargs...)

The name support wildcard.

See more details in the specification.

Keyword arguments

• description = nothing,
• attribute_keys = nothing,
• extra_dimensions = BoundedAttributes(),
• aggregation = nothing,
• instrument_name = nothing,
• instrument_type = nothing,
• meter_name = nothing,
• meter_version = nothing,
• meter_schema_url = nothing,

An AbstractExporter is to export a collection of AbstractSpans and (or) Metrics. Each method should have the following interfaces implemented:

• flush(::AbstractExporter)
• close(::AbstractExporter)
• export!(::AbstractExporter, collection)

Customized id generators must implement the following two methods:

• generate_span_id(::AbstractIdGenerator)
• generate_trace_id(::AbstractIdGenerator)

All metric readers should implement close(::AbstractMetricReader) and (r::AbstractMetricReader)().

Builtin readers:

• CompositMetricReader
• MetricReader
• PeriodicMetricReader

A sampler controls whether to drop a span or not when creating new spans in a certain context. Each sampler should have the should_sample method implemented.

Each span processor must implement the following methods:

• on_start!(span_processor::AbstractSpanProcessor, span::AbstractSpan)
• on_end!(span_processor::AbstractSpanProcessor, span::AbstractSpan)
• close(span_processor::AbstractSpanProcessor)
• flush(span_processor::AbstractSpanProcessor)

AggregationStore{D}(max_points=nothing) where D<:DataPoint

The AggregationStore holds all the aggregated datapoints in a Metric.

Limited(container; limit=32)

Create a container wrapper with limited elements.

The following methods from Base are defined on Limited which are then forwarded to the inner container. Feel free to create a PR if you find any method you need is missing:

• Base.getindex
• Base.setindex!
• Base.iterate
• Base.length
• Base.haskey
• Base.push!. Only defined on containers of AbstractVector.

MetricReader([global_meter_provider()], [ConsoleExporter()])

Note that all metrics will be read on initialization.

(r::MetricReader)()

For async instruments in r, their callbacks will be executed first before reading all the metrics.

OtelBatchLogger(exporter;kw...)

OtelBatchLogger is a Sink (see LoggingExtras.jl to understand the concept). Note that it will create a OtelLogTransformer on construction and apply it automatically on each log message.

Keyword arguments

• max_queue_size=nothing
• scheduled_delay_millis = nothing
• export_timeout_millis = nothing
• max_export_batch_size = nothing
• resource = Resource()
• instrumentation_scope = InstrumentationScope()

PeriodicMetricReader(reader; export_interval_seconds = 60, export_timeout_seconds = 30)

Periodically call the reader in the background.

For PeriodicMetricReader, there's no need to call this method since the read operation will be done periodically in the background.

close(p::TracerProvider)

Shut down inner span processors and then mark itself as shut down.

flush(p::TracerProvider)

Shorthand to force flush inner span processors

Base.push!([p::TracerProvider], sp::AbstractSpanProcessor)

Add an extra span processor sp into the TracerProvider p.

on_end!(ssp::SimpleSpanProcessor, span)

The span is exported immediately if it is sampled.

on_start!(ssp::SimpleSpanProcessor, span)

should_sample(s::AbstractSampler, args...)

Arguments

• parent_span_ctx::SpanContext,
• trace_id::TraceIdType,
• name::String, the span name
• kind::SpanKind,
• attributes, StaticBoundedAttributes or DynamicAttrs
• links, vector of Link
• trace_state::TraceState,