30 releases (breaking)

0.22.0 Feb 25, 2024
0.21.0 Nov 6, 2023
0.20.0 Jul 30, 2023
0.19.0 Mar 26, 2023
0.1.5 Nov 26, 2019

#4 in Debugging

Download history 374456/week @ 2023-12-07 376889/week @ 2023-12-14 202003/week @ 2023-12-21 210206/week @ 2023-12-28 359276/week @ 2024-01-04 361929/week @ 2024-01-11 436167/week @ 2024-01-18 404530/week @ 2024-01-25 433835/week @ 2024-02-01 483499/week @ 2024-02-08 413530/week @ 2024-02-15 501059/week @ 2024-02-22 515659/week @ 2024-02-29 510512/week @ 2024-03-07 519221/week @ 2024-03-14 399221/week @ 2024-03-21

2,038,974 downloads per month
Used in 680 crates (238 directly)

Apache-2.0

265KB
4.5K SLoC

OpenTelemetry — An observability framework for cloud-native software.

OpenTelemetry Rust

The Rust OpenTelemetry implementation.

Crates.io: opentelemetry Documentation LICENSE GitHub Actions CI codecov Slack

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.64+

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

In addition to opentelemetry, which only carries the API, 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.

Contributing

See the contributing file.

Dependencies

~0.4–1MB
~22K SLoC