How can I automatically add attributes to logs such as tracing::info!()? #1497
-
|
I would like to give an attribute of trace_id to the log to tie the log to the trace in New Relic. However, this method is very cumbersome. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 3 replies
-
|
Logs to Trace correlation should be automatically done, if you are using the opentelemetry-tracing-appender. There is no need of explicitly pass the traceid, instead it'll be automatically correlated, as long as you have instrumented using OTel Tracing API for your traces. |
Beta Was this translation helpful? Give feedback.
-
|
Here's my understanding: using opentelemetry-tracing-appender will automatically add the trace.id record. Is this correct? |
Beta Was this translation helpful? Give feedback.
-
|
In the following code, I expected trace.id to be assigned, but it wasn't. I am sending this to NewRelic, but it also wasn't assigned when I checked on NewRelic. Is there a problem with this code? #[tokio::main]
async fn main() {
init_opentelemetry().unwrap();
let tracing_middleware = ServiceBuilder::new()
.layer(TraceLayer::new_for_http().make_span_with(MakeRootSpanWithRemote))
.map_request(record_trace_id);
let app = Router::new()
.route("/", get(handler))
.layer(tracing_middleware);
let listener = tokio::net::TcpListener::bind("127.0.0.1:3000")
.await
.unwrap();
axum::serve(listener, app).await.unwrap();
global::shutdown_tracer_provider();
}
#[derive(Clone)]
struct MakeRootSpanWithRemote;
impl<B> MakeSpan<B> for MakeRootSpanWithRemote {
fn make_span(&mut self, request: &axum::http::Request<B>) -> tracing::Span {
let span = tracing::info_span!(
"request",
http.method = %request.method(),
http.uri = %request.uri(),
http.version = ?request.version(),
otel.name = format!("{} {}", request.method(), request.uri()),
otel.kind = "server",
trace.id = tracing::field::Empty,
span.id = tracing::field::Empty
);
span
}
}
pub fn record_trace_id(request: Request<Body>) -> Request<Body> {
let span = Span::current();
let trace_id = span.context().span().span_context().trace_id();
span.record("trace.id", &trace_id.to_string());
request
}
#[instrument]
async fn fn_a() {
tracing::info!(custom_attr = "fn", "fn_a called");
}
#[instrument]
async fn handler() -> impl IntoResponse {
tracing::info!("request received");
fn_a().await;
"Hello, World!"
}
fn init_opentelemetry() -> Result<(), Box<dyn std::error::Error>> {
let tracer = opentelemetry_otlp::new_pipeline()
.tracing()
.with_exporter(
opentelemetry_otlp::new_exporter()
.http()
.with_endpoint(NEW_RELIC_OTLP_ENDPOINT)
.with_headers(HashMap::from([(
"api-key".into(),
NEW_RELIC_LICENSE_KEY.into(),
)])),
)
.with_trace_config(
trace::config().with_resource(Resource::new(vec![KeyValue::new(
opentelemetry_semantic_conventions::resource::SERVICE_NAME,
NEW_RELIC_SERVICE_NAME,
)])),
)
.install_batch(opentelemetry_sdk::runtime::Tokio)
.expect("Error - Failed to create tracer.");
let otel_trace_layer = tracing_opentelemetry::layer()
.with_error_records_to_exceptions(true)
.with_error_fields_to_exceptions(true)
.with_error_events_to_status(true)
.with_error_events_to_exceptions(true)
.with_location(true)
.with_tracer(tracer);
let provider = LoggerProvider::builder()
.with_config(
opentelemetry_sdk::logs::config().with_resource(Resource::new(vec![KeyValue::new(
opentelemetry_semantic_conventions::resource::SERVICE_NAME,
NEW_RELIC_SERVICE_NAME,
)])),
)
.with_simple_exporter(opentelemetry_stdout::LogExporter::default())
.build();
let otel_logs_layer = opentelemetry_appender_tracing::layer::OpenTelemetryTracingBridge::new(&provider);
let fmt_layer = tracing_subscriber::fmt::layer()
.pretty()
.with_ansi(true)
.with_file(true)
.with_line_number(true)
.with_thread_names(true)
.with_timer(tracing_subscriber::fmt::time::OffsetTime::new(
offset!(+09:00:00),
time::format_description::well_known::Rfc3339,
))
.with_target(true);
tracing_subscriber::registry()
.with(otel_trace_layer)
.with(otel_logs_layer)
.with(fmt_layer)
.with(tracing_subscriber::filter::LevelFilter::INFO)
.init();
Ok(())
}stdout{"resourceLogs":[{"resource":{"attributes":[{"key":"service.name","value":{"stringValue":"example-rust-otel"}}]},"scopeLogs":[{"scope":{"name":"opentelemetry-appender-tracing","version":"0.4.0"},"logRecords":[{"timeUnixNano":null,"time":null,"observedTimeUnixNano":1718289766131594735,"observedTime":"2024-06-13 14:42:46.131","severityNumber":9,"severityText":"INFO","body":{"stringValue":"fn_a called"},"attributes":[{"key":"name","value":{"stringValue":"event src/main.rs:79"}},{"key":"custom_attr","value":{"stringValue":"fn"}}],"droppedAttributesCount":0}]}]}]} |
Beta Was this translation helpful? Give feedback.
-
|
@Romira915
Since you are using I fully understand that this is not a great situation to be in. There isn't an easy solution without resolving the fundamental issues above :( |
Beta Was this translation helpful? Give feedback.
Logs to Trace correlation should be automatically done, if you are using the opentelemetry-tracing-appender. There is no need of explicitly pass the traceid, instead it'll be automatically correlated, as long as you have instrumented using OTel Tracing API for your traces.