[][src]Module opentelemetry::api

OpenTelemetry API: What applications use and SDKs implement.

OpenTelemetry Language Libraries are composed of 2 packages: api and sdk.

Third-party libraries and frameworks that want to be instrumented in OpenTelemetry-compatible way will have a dependency on the api package. The developers of these third-party libraries will add calls to telemetry API to produce telemetry data.

Applications that use third-party libraries that are instrumented with OpenTelemetry API will have a choice to enable or not enable the actual delivery of telemetry data. The application can also call telemetry API directly to produce additional telemetry data.

In order to enable telemetry the application must take a dependency on the OpenTelemetry SDK, which implements the delivery of the telemetry. The application must also configure exporters so that the SDK knows where and how to deliver the telemetry.

Modules

labels

OpenTelemetry Labels

propagation

OpenTelemetry Propagator interface

trace

OpenTelemetry Tracing API.

Structs

Baggage

A set of name/value pairs describing user-defined properties across systems.

Context

An execution-scoped collection of values.

Key

Key used for metric LabelSets and trace Span attributes.

KeyValue

KeyValue pairs are used by LabelSets and Span attributes.

Unit

Units denote underlying data units tracked by Meters.

Enums

Value

Value types for use in KeyValue pairs.

Traits

BaggageExt

Methods for sorting and retrieving baggage data in a context.