mirror of
https://github.com/tokio-rs/tracing.git
synced 2025-10-02 15:24:47 +00:00
16d1369e3c
## Motivation Currently, when converting `log::Record`s to `tracing::Event`s using `tracing-log`, data from `log`'s metadata is converted to special fields prefixed with `log.`, rather than being recorded as `tracing` metadata. In order to properly display this data from `log`, the `tracing-log` crate provides the [`NormalizeMetadata` trait](https://docs.rs/tracing-log/0.1.1/tracing_log/trait.NormalizeEvent.html). `tracing-opentelemetry` does not currently use this, however, and location data from `log` events is treated as a regular field rather than a source code location in OpenTelemetry logs. ## Solution Update `tracing-opentelemetry`'s `on_event` implementation to format recorded logs similarly to how `tracing-subscriber::fmt` does. Event metadata is normalized and intermediate `log.` prefixed values are properly ignored. This is flagged under a new `tracing-log` feature that is enabled by default but allows for opting-out.
Tracing OpenTelemetry
Utilities for adding OpenTelemetry interoperability to tracing.
Overview
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.
The crate provides the following types:
OpenTelemetryLayeradds OpenTelemetry context to alltracingspans.OpenTelemetrySpanExtallows OpenTelemetry parent trace information to be injected and extracted from atracingspan.
Examples
Basic Usage
use opentelemetry::{api::Provider, sdk};
use tracing::{error, span};
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::Registry;
fn main() {
// Create a new tracer
let tracer = sdk::Provider::default().get_tracer("component_name");
// Create a new OpenTelemetry tracing layer
let telemetry = tracing_opentelemetry::layer().with_tracer(tracer);
let subscriber = Registry::default().with(telemetry);
// Trace executed code
tracing::subscriber::with_default(subscriber, || {
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.");
});
}
Visualization example
# Run a supported collector like jaeger in the background
$ docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest
# Run example to produce spans (from parent examples directory)
$ cargo run --example opentelemetry
# View spans (see the image below)
$ firefox http://localhost:16686/
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tracing by you, shall be licensed as MIT, without any additional terms or conditions.