[SEMANTIC CONVENTIONS] Rework on semantic conventions 1.25.0 (#2640)

open-telemetry · Apr 17, 2024 · 7aea1a6 · 7aea1a6 · github-actions · Apr 17, 2024
1 parent 950c336
commit 7aea1a6
Show file tree

Hide file tree

Showing 10 changed files with 3,700 additions and 65 deletions.
diff --git a/buildscripts/semantic-convention/generate.sh b/buildscripts/semantic-convention/generate.sh
@@ -80,7 +80,7 @@ docker run --rm \
   -v ${SCRIPT_DIR}/templates:/templates${USE_MOUNT_OPTION} \
   -v ${ROOT_DIR}/sdk/include/opentelemetry/sdk/resource/:/output${USE_MOUNT_OPTION} \
   otel/semconvgen:$GENERATOR_VERSION \
-  --only resource \
+  --only resource,attribute_group \
   -f /source code \
   --template /templates/SemanticAttributes.h.j2 \
   --output /output/semantic_conventions.h \

diff --git a/examples/grpc/client.cc b/examples/grpc/client.cc
@@ -50,11 +50,11 @@ class GreeterClient
     std::string span_name = "GreeterClient/Greet";
     auto span             = get_tracer("grpc")->StartSpan(
         span_name,
-        {{opentelemetry::trace::SemanticConventions::kRpcSystem, "grpc"},
-         {opentelemetry::trace::SemanticConventions::kRpcService, "grpc-example.GreetService"},
-         {opentelemetry::trace::SemanticConventions::kRpcMethod, "Greet"},
-         {opentelemetry::trace::SemanticConventions::kNetworkPeerAddress, ip},
-         {opentelemetry::trace::SemanticConventions::kNetworkPeerPort, port}},
+        {{SemanticConventions::kRpcSystem, "grpc"},
+         {SemanticConventions::kRpcService, "grpc-example.GreetService"},
+         {SemanticConventions::kRpcMethod, "Greet"},
+         {SemanticConventions::kNetworkPeerAddress, ip},
+         {SemanticConventions::kNetworkPeerPort, port}},
         options);
 
     auto scope = get_tracer("grpc-client")->WithActiveSpan(span);
@@ -70,8 +70,7 @@ class GreeterClient
     if (status.ok())
     {
       span->SetStatus(StatusCode::kOk);
-      span->SetAttribute(opentelemetry::trace::SemanticConventions::kRpcGrpcStatusCode,
-                         status.error_code());
+      span->SetAttribute(SemanticConventions::kRpcGrpcStatusCode, status.error_code());
       // Make sure to end your spans!
       span->End();
       return response.response();
@@ -80,8 +79,7 @@ class GreeterClient
     {
       std::cout << status.error_code() << ": " << status.error_message() << std::endl;
       span->SetStatus(StatusCode::kError);
-      span->SetAttribute(opentelemetry::trace::SemanticConventions::kRpcGrpcStatusCode,
-                         status.error_code());
+      span->SetAttribute(SemanticConventions::kRpcGrpcStatusCode, status.error_code());
       // Make sure to end your spans!
       span->End();
       return "RPC failed";

diff --git a/examples/grpc/server.cc b/examples/grpc/server.cc
@@ -67,14 +67,13 @@ class GreeterServer final : public Greeter::Service
     options.parent   = GetSpan(new_context)->GetContext();
 
     std::string span_name = "GreeterService/Greet";
-    auto span             = get_tracer("grpc")->StartSpan(
-        span_name,
-        {{opentelemetry::trace::SemanticConventions::kRpcSystem, "grpc"},
-         {opentelemetry::trace::SemanticConventions::kRpcService, "GreeterService"},
-         {opentelemetry::trace::SemanticConventions::kRpcMethod, "Greet"},
-         {opentelemetry::trace::SemanticConventions::kRpcGrpcStatusCode, 0}},
-        options);
-    auto scope = get_tracer("grpc")->WithActiveSpan(span);
+    auto span             = get_tracer("grpc")->StartSpan(span_name,
+                                              {{SemanticConventions::kRpcSystem, "grpc"},
+                                               {SemanticConventions::kRpcService, "GreeterService"},
+                                               {SemanticConventions::kRpcMethod, "Greet"},
+                                               {SemanticConventions::kRpcGrpcStatusCode, 0}},
+                                              options);
+    auto scope            = get_tracer("grpc")->WithActiveSpan(span);
 
     // Fetch and parse whatever HTTP headers we can from the gRPC request.
     span->AddEvent("Processing client attributes");

diff --git a/examples/http/client.cc b/examples/http/client.cc
@@ -24,13 +24,12 @@ void sendRequest(const std::string &url)
   opentelemetry::ext::http::common::UrlParser url_parser(url);
 
   std::string span_name = url_parser.path_;
-  auto span =
-      get_tracer("http-client")
-          ->StartSpan(span_name,
-                      {{opentelemetry::trace::SemanticConventions::kUrlFull, url_parser.url_},
-                       {opentelemetry::trace::SemanticConventions::kUrlScheme, url_parser.scheme_},
-                       {opentelemetry::trace::SemanticConventions::kHttpRequestMethod, "GET"}},
-                      options);
+  auto span             = get_tracer("http-client")
+                  ->StartSpan(span_name,
+                              {{SemanticConventions::kUrlFull, url_parser.url_},
+                               {SemanticConventions::kUrlScheme, url_parser.scheme_},
+                               {SemanticConventions::kHttpRequestMethod, "GET"}},
+                              options);
   auto scope = get_tracer("http-client")->WithActiveSpan(span);
 
   // inject current context into http header
@@ -45,8 +44,7 @@ void sendRequest(const std::string &url)
   {
     // set span attributes
     auto status_code = result.GetResponse().GetStatusCode();
-    span->SetAttribute(opentelemetry::trace::SemanticConventions::kHttpResponseStatusCode,
-                       status_code);
+    span->SetAttribute(SemanticConventions::kHttpResponseStatusCode, status_code);
     result.GetResponse().ForEachHeader(
         [&span](nostd::string_view header_name, nostd::string_view header_value) {
           span->SetAttribute("http.header." + std::string(header_name.data()), header_value);

diff --git a/examples/http/server.cc b/examples/http/server.cc
@@ -38,18 +38,16 @@ class RequestHandler : public HTTP_SERVER_NS::HttpRequestCallback
     options.parent   = GetSpan(new_context)->GetContext();
 
     // start span with parent context extracted from http header
-    auto span =
-        get_tracer("http-server")
-            ->StartSpan(
-                span_name,
-                {{opentelemetry::trace::SemanticConventions::kServerAddress, server_name},
-                 {opentelemetry::trace::SemanticConventions::kServerPort, server_port},
-                 {opentelemetry::trace::SemanticConventions::kHttpRequestMethod, request.method},
-                 {opentelemetry::trace::SemanticConventions::kUrlScheme, "http"},
-                 {opentelemetry::trace::SemanticConventions::kHttpRequestBodySize,
-                  static_cast<uint64_t>(request.content.length())},
-                 {opentelemetry::trace::SemanticConventions::kClientAddress, request.client}},
-                options);
+    auto span = get_tracer("http-server")
+                    ->StartSpan(span_name,
+                                {{SemanticConventions::kServerAddress, server_name},
+                                 {SemanticConventions::kServerPort, server_port},
+                                 {SemanticConventions::kHttpRequestMethod, request.method},
+                                 {SemanticConventions::kUrlScheme, "http"},
+                                 {SemanticConventions::kHttpRequestBodySize,
+                                  static_cast<uint64_t>(request.content.length())},
+                                 {SemanticConventions::kClientAddress, request.client}},
+                                options);
 
     auto scope = get_tracer("http_server")->WithActiveSpan(span);
 

diff --git a/exporters/zipkin/src/recordable.cc b/exporters/zipkin/src/recordable.cc
@@ -4,7 +4,6 @@
 #include "opentelemetry/exporters/zipkin/recordable.h"
 #include "opentelemetry/sdk/resource/resource.h"
 #include "opentelemetry/sdk/resource/semantic_conventions.h"
-#include "opentelemetry/trace/semantic_conventions.h"
 
 #include <map>
 #include <string>
@@ -224,9 +223,9 @@ void Recordable::SetResource(const sdk::resource::Resource &resource) noexcept
 {
   // only service.name attribute is supported by specs as of now.
   auto attributes = resource.GetAttributes();
-  if (attributes.find(trace::SemanticConventions::kServiceName) != attributes.end())
+  if (attributes.find(SemanticConventions::kServiceName) != attributes.end())
   {
-    service_name_ = nostd::get<std::string>(attributes[trace::SemanticConventions::kServiceName]);
+    service_name_ = nostd::get<std::string>(attributes[SemanticConventions::kServiceName]);
   }
 }
Benchmark suite	Current: `7aea1a6`	Previous: `950c336`	Ratio
`BM_BaselineBuffer/1`	`12720110.416412354` ns/iter	`3586691.6179656982` ns/iter	`3.55`
`BM_BaselineBuffer/2`	`13848445.415496826` ns/iter	`2298713.332040755` ns/iter	`6.02`
`BM_BaselineBuffer/4`	`15030226.707458496` ns/iter	`2484216.6214538137` ns/iter	`6.05`
`BM_LockFreeBuffer/2`	`6870628.445906125` ns/iter	`1040728.8074493408` ns/iter	`6.60`
`BM_LockFreeBuffer/4`	`10280666.35131836` ns/iter	`1065638.1216574842` ns/iter	`9.65`