Crate tracing_opentelemetry[][src]

Expand description

Tracing OpenTelemetry

tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. This crate provides a layer that connects spans from multiple systems into a trace and emits them to OpenTelemetry-compatible distributed tracing systems for processing and visualization.

Compiler support: requires rustc 1.42+

Special Fields

Fields with an otel. prefix are reserved for this crate and have specific meaning. They are treated as ordinary fields by other layers. The current special fields are:

  • otel.name: Override the span name sent to OpenTelemetry exporters. Setting this field is useful if you want to display non-static information in your span name.
  • otel.kind: Set the span kind to one of the supported OpenTelemetry span kinds.
  • otel.status_code: Set the span status code to one of the supported OpenTelemetry span status codes.
  • otel.status_message: Set the span status message.

Semantic Conventions

OpenTelemetry defines conventional names for attributes of common operations. These names can be assigned directly as fields, e.g. trace_span!("request", "otel.kind" = %SpanKind::Client, "http.url" = ..), and they will be passed through to your configured OpenTelemetry exporter. You can find the full list of the operations and their expected field names in the semantic conventions spec.

Stability Status

The OpenTelemetry specification is currently in beta so some breaking changes may still occur on the path to 1.0. You can follow the changes via the spec repository to track progress toward stabilization.

Examples

use opentelemetry::sdk::export::trace::stdout;
use tracing::{error, span};
use tracing_subscriber::subscribe::CollectExt;
use tracing_subscriber::Registry;

// Create a new OpenTelemetry pipeline
let tracer = stdout::new_pipeline().install_simple();

// Create a tracing layer with the configured tracer
let telemetry = tracing_opentelemetry::subscriber().with_tracer(tracer);

// Use the tracing subscriber `Registry`, or any other subscriber
// that impls `LookupSpan`
let subscriber = Registry::default().with(telemetry);

// Trace executed code
tracing::collect::with_default(subscriber, || {
    // Spans will be sent to the configured OpenTelemetry exporter
    let root = span!(tracing::Level::TRACE, "app_start", work_units = 2);
    let _enter = root.enter();

    error!("This event will be logged in the root span.");
});

Supported Rust Versions

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

Tracing follows the same compiler support policies as the rest of the Tokio project. 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.45, the minimum supported version will not be increased past 1.42, 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.

Structs

An OpenTelemetry propagation subscriber for use in a project that uses tracing.

Traits

Utility functions to allow tracing Spans to accept and return OpenTelemetry Contexts.

An interface for authors of OpenTelemetry SDKs to build pre-sampled tracers.

Functions

Construct a subscriber to track spans via OpenTelemetry.