wip: use opentelemetry-semantic-conventions instead of static &str

davidB · davidB · commit e955a1de743b · 2025-10-14T12:37:42.000+02:00
diff --git a/axum-tracing-opentelemetry/Cargo.toml b/axum-tracing-opentelemetry/Cargo.toml
@@ -24,6 +24,7 @@ http = { workspace = true }
 opentelemetry = { workspace = true, features = [
   "trace",
 ], default-features = false }
+opentelemetry-semantic-conventions = { workspace = true }
 pin-project-lite = "0.2"
 tower = { workspace = true }
 tracing = { workspace = true }
diff --git a/axum-tracing-opentelemetry/src/middleware/trace_extractor.rs b/axum-tracing-opentelemetry/src/middleware/trace_extractor.rs
@@ -34,6 +34,7 @@
 
 use axum::extract::{ConnectInfo, MatchedPath};
 use http::{Request, Response};
+use opentelemetry_semantic_conventions::attribute::{CLIENT_ADDRESS, HTTP_ROUTE};
 use pin_project_lite::pin_project;
 use std::{
     error::Error,
@@ -155,10 +156,10 @@ where
             };
 
             let span = otel_http::http_server::make_span_from_request(&req);
-            span.record("http.route", route);
+            span.record(HTTP_ROUTE, route);
             span.record("otel.name", format!("{method} {route}").trim());
             if let Some(client_ip) = client_ip {
-                span.record("client.address", client_ip);
+                span.record(CLIENT_ADDRESS, client_ip);
             }
             if let Err(error) = span.set_parent(otel_http::extract_context(req.headers())) {
                 tracing::warn!(?error, "can not set parent trace_id to span");
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__call_with_w3c_trace_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__call_with_w3c_trace_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__empty_http_route_for_nonexisting_route_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__empty_http_route_for_nonexisting_route_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"404\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__extract_route_from_nested_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__extract_route_from_nested_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__filled_http_headers_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__filled_http_headers_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__filled_http_route_for_existing_route_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__filled_http_route_for_existing_route_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__status_code_on_close_for_error_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__status_code_on_close_for_error_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"500\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__status_code_on_close_for_ok_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__status_code_on_close_for_ok_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__trace_id_in_child_span_for_remote_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__trace_id_in_child_span_for_remote_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"axum-tracing-opentelemetry/src/middleware/trace_extractor.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(256)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(257)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"axum_tracing_opentelemetry::middleware::trace_extractor::tests\")) })"
     idle_ns: ignore
     target: "Some(AnyValue { value: Some(StringValue(\"axum_tracing_opentelemetry::middleware::trace_extractor::tests\")) })"
@@ -38,7 +38,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__trace_id_in_child_span_otel_spans.snap b/testing-tracing-opentelemetry/src/snapshots/testing_tracing_opentelemetry__trace_id_in_child_span_otel_spans.snap
@@ -13,7 +13,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"axum-tracing-opentelemetry/src/middleware/trace_extractor.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(256)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(257)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"axum_tracing_opentelemetry::middleware::trace_extractor::tests\")) })"
     idle_ns: ignore
     target: "Some(AnyValue { value: Some(StringValue(\"axum_tracing_opentelemetry::middleware::trace_extractor::tests\")) })"
@@ -38,7 +38,7 @@ expression: otel_spans
   attributes:
     busy_ns: ignore
     code.file.path: "Some(AnyValue { value: Some(StringValue(\"tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs\")) })"
-    code.line.number: "Some(AnyValue { value: Some(IntValue(13)) })"
+    code.line.number: "Some(AnyValue { value: Some(IntValue(15)) })"
     code.module.name: "Some(AnyValue { value: Some(StringValue(\"tracing_opentelemetry_instrumentation_sdk::http::http_server\")) })"
     http.request.method: "Some(AnyValue { value: Some(StringValue(\"GET\")) })"
     http.response.status_code: "Some(AnyValue { value: Some(StringValue(\"200\")) })"
diff --git a/tracing-opentelemetry-instrumentation-sdk/Cargo.toml b/tracing-opentelemetry-instrumentation-sdk/Cargo.toml
@@ -18,6 +18,9 @@ license.workspace = true
 [dependencies]
 http = { workspace = true, optional = true }
 opentelemetry = { workspace = true }
+opentelemetry-semantic-conventions = { workspace = true, features = [
+  "semconv_experimental",
+] }
 tracing = { workspace = true }
 tracing-opentelemetry = { workspace = true }
 
diff --git a/tracing-opentelemetry-instrumentation-sdk/src/http/grpc.rs b/tracing-opentelemetry-instrumentation-sdk/src/http/grpc.rs
@@ -1,4 +1,7 @@
 use http::HeaderMap;
+use opentelemetry_semantic_conventions::attribute::{
+    EXCEPTION_MESSAGE, OTEL_STATUS_CODE, RPC_GRPC_STATUS_CODE,
+};
 
 /// [`gRPC` status codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md#status-codes-and-their-use-in-grpc)
 /// copied from tonic
@@ -67,12 +70,12 @@ pub fn update_span_from_response<B>(
     let status = status_from_http_header(response.headers())
         .or_else(|| status_from_http_status(response.status()))
         .unwrap_or(GrpcCode::Ok as u16);
-    span.record("rpc.grpc.status_code", status);
+    span.record(RPC_GRPC_STATUS_CODE, status);
 
     if status_is_error(status, is_spankind_server) {
-        span.record("otel.status_code", "ERROR");
+        span.record(OTEL_STATUS_CODE, "ERROR");
     } else {
-        span.record("otel.status_code", "OK");
+        span.record(OTEL_STATUS_CODE, "OK");
     }
 }
 
@@ -122,12 +125,12 @@ fn update_span_from_error<E>(span: &tracing::Span, error: &E)
 where
     E: std::error::Error,
 {
-    span.record("otel.status_code", "ERROR");
-    span.record("rpc.grpc.status_code", 2);
-    span.record("exception.message", error.to_string());
+    span.record(OTEL_STATUS_CODE, "ERROR");
+    span.record(RPC_GRPC_STATUS_CODE, 2);
+    span.record(EXCEPTION_MESSAGE, error.to_string());
     error
         .source()
-        .map(|s| span.record("exception.message", s.to_string()));
+        .map(|s| span.record(EXCEPTION_MESSAGE, s.to_string()));
 }
 
 pub fn update_span_from_response_or_error<B, E>(
diff --git a/tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs b/tracing-opentelemetry-instrumentation-sdk/src/http/http_server.rs
@@ -3,6 +3,8 @@ use std::error::Error;
 use crate::http::{http_flavor, http_host, url_scheme, user_agent};
 use crate::otel_trace_span;
 use crate::span_type::SpanType;
+use opentelemetry_semantic_conventions::attribute::OTEL_STATUS_CODE;
+use opentelemetry_semantic_conventions::trace::{EXCEPTION_MESSAGE, HTTP_RESPONSE_STATUS_CODE};
 use tracing::field::Empty;
 
 pub fn make_span_from_request<B>(req: &http::Request<B>) -> tracing::Span {
@@ -35,29 +37,29 @@ pub fn make_span_from_request<B>(req: &http::Request<B>) -> tracing::Span {
 
 pub fn update_span_from_response<B>(span: &tracing::Span, response: &http::Response<B>) {
     let status = response.status();
-    span.record("http.response.status_code", status.as_u16());
+    span.record(HTTP_RESPONSE_STATUS_CODE, status.as_u16());
 
     if status.is_server_error() {
-        span.record("otel.status_code", "ERROR");
+        span.record(OTEL_STATUS_CODE, "ERROR");
         // see [http-spans.md#status](https://github.com/open-telemetry/semantic-conventions/blob/v1.25.0/docs/http/http-spans.md#status)
         // Span Status MUST be left unset if HTTP status code was in the 1xx, 2xx or 3xx ranges,
         // unless there was another error (e.g., network error receiving the response body;
         // or 3xx codes with max redirects exceeded), in which case status MUST be set to Error.
         // } else {
-        //     span.record("otel.status_code", "OK");
+        //     span.record(OTEL_STATUS_CODE, "OK");
     }
 }
 
 pub fn update_span_from_error<E>(span: &tracing::Span, error: &E)
 where
     E: Error,
 {
-    span.record("otel.status_code", "ERROR");
-    //span.record("http.status_code", 500);
-    span.record("exception.message", error.to_string());
+    span.record(OTEL_STATUS_CODE, "ERROR");
+    //span.record(HTTP_RESPONSE_STATUS_CODE, 500);
+    span.record(EXCEPTION_MESSAGE, error.to_string());
     error
         .source()
-        .map(|s| span.record("exception.message", s.to_string()));
+        .map(|s| span.record(EXCEPTION_MESSAGE, s.to_string()));
 }
 
 pub fn update_span_from_response_or_error<B, E>(
diff --git a/tracing-opentelemetry-instrumentation-sdk/src/lib.rs b/tracing-opentelemetry-instrumentation-sdk/src/lib.rs
@@ -33,6 +33,7 @@ pub const TRACING_LEVEL: tracing::Level = tracing::Level::INFO;
 ///
 /// [Fields] and [attributes] are set using the same syntax as the [`tracing::span!`]
 /// macro.
+//TODO find a way to use opentelemetry_semantic_conventions::attribute::* as part of the field
 #[macro_export]
 macro_rules! otel_trace_span {
     (parent: $parent:expr, $name:expr, $($field:tt)*) => {
