feat(boto3): align span names with OTel conventions

- use modeled `ServiceID` and operation for span names: `aws.<hyphenized-service-id>.<Operation>` to `<ServiceID>.<Operation>`; e.g. `aws.s3.GetObject` => `S3.GetObject`

Author: pabloDeputter

sentry_sdk/integrations/boto3/_instrumentation.py

@@ -156,10 +156,9 @@ def _start_client_span(ctx: "AwsCallContext") -> "Optional[Span]":
     if client.get_integration(IDENTIFIER) is None:
         return None
 
-    # use unknown if `service_id_hyphenized` is not set so span name can still be created.
-    # e.g. "aws.unknown.GetObject"
-    service_name = ctx.service_id_hyphenized or "unknown"
-    span_name = f"aws.{service_name}.{ctx.operation_name}"
+    # https://opentelemetry.io/docs/specs/semconv/cloud-providers/aws-sdk/#aws-sdk-spans
+    service_name = ctx.service_id or "unknown"
+    span_name = f"{service_name}.{ctx.operation_name}"
     attributes: "Attributes" = {
         SPANDATA.RPC_METHOD: ctx.operation_name,
         SPANDATA.RPC_SYSTEM_NAME: AWS_RPC_SYSTEM_NAME,

tests/integrations/boto3/test_client.py

@@ -125,7 +125,7 @@ def record_client_span(request, **kwargs):
     client_spans = [
         span
         for span in spans
-        if span.get("name", span.get("description")) == "aws.s3.GetObject"
+        if span.get("name", span.get("description")) == "S3.GetObject"
         and (
             span["attributes"].get(SPANDATA.SENTRY_ORIGIN) == ORIGIN
             and span["attributes"].get(SPANDATA.SENTRY_OP) == OP.HTTP_CLIENT
@@ -141,7 +141,7 @@ def record_client_span(request, **kwargs):
     stream_spans = [
         span
         for span in spans
-        if span.get("name", span.get("description")) == "aws.s3.GetObject"
+        if span.get("name", span.get("description")) == "S3.GetObject"
         and (span["attributes"].get(SPANDATA.SENTRY_OP) == OP.HTTP_CLIENT_STREAM)
     ]
     assert len(client_spans) == 1
@@ -437,7 +437,7 @@ def test_get_response_attributes_ignores_malformed_field(field, value, attribute
             "s3",
             "head_object",
             {"Bucket": "bucket", "Key": "foo"},
-            "aws.s3.HeadObject",
+            "S3.HeadObject",
             "S3",
             "HeadObject",
             "http://localhost:4566",
@@ -448,13 +448,24 @@ def test_get_response_attributes_ignores_malformed_field(field, value, attribute
             "events",
             "list_event_buses",
             {},
-            "aws.eventbridge.ListEventBuses",
+            "EventBridge.ListEventBuses",
             "EventBridge",
             "ListEventBuses",
             None,
             "events.eu-north-1.amazonaws.com",
             443,
         ),
+        (
+            "apigateway",
+            "get_rest_apis",
+            {},
+            "API Gateway.GetRestApis",
+            "API Gateway",
+            "GetRestApis",
+            None,
+            "apigateway.eu-north-1.amazonaws.com",
+            443,
+        ),
     ],
 )
 def test_client_call_has_common_attributes(

tests/integrations/boto3/test_s3.py

@@ -48,7 +48,7 @@ def test_basic(
     assert len(spans) == 2
     span = spans[0]
     assert span["attributes"]["sentry.op"] == "http.client"
-    assert span["name"] == "aws.s3.ListObjects"
+    assert span["name"] == "S3.ListObjects"
 
 
 def test_streaming(sentry_init, capture_items):
@@ -79,11 +79,11 @@ def test_streaming(sentry_init, capture_items):
 
     stream_span, client_span, parent_span = spans
     assert stream_span["attributes"]["sentry.op"] == "http.client.stream"
-    assert stream_span["name"] == "aws.s3.GetObject"
+    assert stream_span["name"] == "S3.GetObject"
     assert stream_span["parent_span_id"] == client_span["span_id"]
 
     assert client_span["attributes"]["sentry.op"] == "http.client"
-    assert client_span["name"] == "aws.s3.GetObject"
+    assert client_span["name"] == "S3.GetObject"
     assert client_span["parent_span_id"] == parent_span["span_id"]
 
     assert parent_span["name"] == "custom parent"
@@ -137,11 +137,11 @@ def test_streaming_close(sentry_init, capture_items):
 
     stream_span, client_span, parent_span = spans
     assert stream_span["attributes"]["sentry.op"] == "http.client.stream"
-    assert stream_span["name"] == "aws.s3.GetObject"
+    assert stream_span["name"] == "S3.GetObject"
     assert stream_span["parent_span_id"] == client_span["span_id"]
 
     assert client_span["attributes"]["sentry.op"] == "http.client"
-    assert client_span["name"] == "aws.s3.GetObject"
+    assert client_span["name"] == "S3.GetObject"
     assert client_span["parent_span_id"] == parent_span["span_id"]
 
     assert parent_span["name"] == "custom parent"