OpenTelemetry Rust

The Rust OpenTelemetry implementation.

Website | Slack | Documentation

Overview

OpenTelemetry is a collection of tools, APIs, and SDKs used to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior. You can export and analyze them using Prometheus, Jaeger, and other observability tools.

Compiler support: requires rustc 1.65+

Project Status

Signal	Status
Logs	Alpha*
Metrics	Alpha
Traces	Beta

*OpenTelemetry Rust is not introducing a new end user callable Logging API. Instead, it provides Logs Bridge API, that allows one to write log appenders that can bridge existing logging libraries to the OpenTelemetry log data model. The following log appenders are available:

• opentelemetry-appender-log
• opentelemetry-appender-tracing
• opentelemetry-appender-slog // TODO: Add link once available

If you already use the logging APIs from above, continue to use them, and use the appenders above to bridge the logs to OpenTelemetry. If you are using a library not listed here, feel free to contribute a new appender for the same.

If you are starting fresh, then consider using tracing as your logging API. It supports structured logging and is actively maintained.

Project versioning information and stability guarantees can be found here.

Getting Started

use opentelemetry::{
    global,
    sdk::trace::TracerProvider,
    trace::{Tracer, TracerProvider as _},
};

fn main() {
    // Create a new trace pipeline that prints to stdout
    let provider = TracerProvider::builder()
        .with_simple_exporter(opentelemetry_stdout::SpanExporter::default())
        .build();
    let tracer = provider.tracer("readme_example");

    tracer.in_span("doing_work", |cx| {
        // Traced app logic here...
    });

    // Shutdown trace pipeline
    global::shutdown_tracer_provider();
}

See the examples directory for different integration patterns.

Ecosystem

Related Crates

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:

• opentelemetry-aws provides unofficial propagators for AWS X-ray.
• opentelemetry-datadog provides additional exporters to Datadog.
• opentelemetry-dynatrace provides additional exporters to Dynatrace.
• opentelemetry-contrib provides additional exporters and propagators that are experimental.
• opentelemetry-http provides an interface for injecting and extracting trace information from http headers.
• opentelemetry-jaeger provides context propagation using jaeger propagation format.
• opentelemetry-otlp exporter for sending trace and metric data in the OTLP format to the OpenTelemetry collector.
• opentelemetry-prometheus provides a pipeline and exporter for sending metrics information to Prometheus.
• opentelemetry-semantic-conventions provides standard names and semantic otel conventions.
• opentelemetry-stackdriver provides an exporter for Google's Cloud Trace (which used to be called StackDriver).
• opentelemetry-zipkin provides a pipeline and exporter for sending trace information to Zipkin.

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

• tracing-opentelemetry provides integration for applications instrumented using the tracing API and ecosystem.
• actix-web-opentelemetry provides integration for the actix-web web server and ecosystem.
• opentelemetry-application-insights provides an unofficial Azure Application Insights exporter.
• opentelemetry-tide provides integration for the Tide web server and ecosystem.
• trillium-opentelemetry provides metrics instrumentation for trillium http servers following semantic-conventions.

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.

Contributing

See the contributing file.

The Rust special interest group (SIG) meets weekly on Tuesdays at 9 AM Pacific Time. The meeting is subject to change depending on contributors' availability. Check the OpenTelemetry community calendar for specific dates and for Zoom meeting links. "OTel Rust SIG" is the name of meeting for this group.

Meeting notes are available as a public Google doc. If you have trouble accessing the doc, please get in touch on Slack.

The meeting is open for all to join. We invite everyone to join our meeting, regardless of your experience level. Whether you're a seasoned OpenTelemetry developer, just starting your journey, or simply curious about the work we do, you're more than welcome to participate!