Crate opentelemetry

source ·
Expand description

Implements the API component of OpenTelemetry.

Compiler support: requires rustc 1.64+

§Getting Started

use opentelemetry::{global, trace::{TraceContextExt, Tracer}, Context };

fn do_something() {
    let tracer = global::tracer("my_component");
    let _guard = Context::current_with_span(tracer.start("my_span")).attach();
    // do work tracked by the now current span

See the examples directory for different integration patterns.


The trace module includes types for tracking the progression of a single request while it is handled by services that make up an application. A trace is a tree of Spans which are objects that represent the work being done by individual services or components involved in a request as it flows through a system.

§Creating and exporting spans

use opentelemetry::{global, trace::{Span, Tracer}, KeyValue};

// get a tracer from a provider
let tracer = global::tracer("my_service");

// start a new span
let mut span = tracer.start("my_span");

// set some attributes
span.set_attribute(KeyValue::new("http.client_ip", ""));

// perform some more work...

// end or drop the span to export

See the trace module docs for more information on creating and managing spans.


The metrics module includes types for recording measurements about a service at runtime.

§Creating instruments and recording measurements

use opentelemetry::{global, KeyValue};

// get a meter from a provider
let meter = global::meter("my_service");

// create an instrument
let counter = meter.u64_counter("my_counter").init();

// record a measurement
counter.add(1, &[KeyValue::new("http.client_ip", "")]);

See the metrics module docs for more information on creating and managing instruments.

§Crate Feature Flags

The following core crate feature flags are available:

  • trace: Includes the trace API (enabled by default).
  • metrics: Includes the unstable metrics API.
  • logs: Includes the logs bridge API.

In addition to opentelemetry, the open-telemetry/opentelemetry-rust repository contains several additional crates designed to be used with the opentelemetry ecosystem. This includes a collection of trace SpanExporter and metrics pull and push controller implementations, as well as utility and adapter crates to assist in propagating state and instrumenting applications.

In particular, the following crates are likely to be of interest:

Additionally, there are also several third-party crates which are not maintained by the opentelemetry project. These include:

If you’re the maintainer of an opentelemetry ecosystem crate not listed above, please let us know! We’d love to add your project to the list!

§Supported Rust Versions

OpenTelemetry is built against the latest stable release. The minimum supported version is 1.64. The current OpenTelemetry version is not guaranteed to build on Rust versions earlier than the minimum supported version.

The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.49, the minimum supported version will not be increased past 1.46, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.


  • Primitives for sending name/value data across system boundaries.
  • Utilities for working with global telemetry primitives
  • OpenTelemetry Metrics API
  • OpenTelemetry Propagator interface
  • API for tracing applications and libraries.


  • An execution-scoped collection of values.
  • A guard that resets the current context to the prior context when dropped.
  • Information about a library or crate providing instrumentation.
  • The key part of attribute KeyValue pairs.
  • A key-value pair describing an attribute.
  • A hash table implementation that preserves insertion order across all operations.
  • Wrapper for string-like values



  • Marker trait for errors returned by exporters