Capture server attributes for botocore API calls

Author: SrdjanLL

instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -82,6 +82,7 @@ def response_hook(span, service_name, operation_name, result):
 
 import logging
 from typing import Any, Callable, Collection, Dict, Optional, Tuple
+from urllib.parse import urlparse
 
 from botocore.client import BaseClient
 from botocore.endpoint import Endpoint
@@ -277,6 +278,7 @@ def _patched_api_call(self, original_func, instance, args, kwargs):
             SpanAttributes.RPC_METHOD: call_context.operation,
             # TODO: update when semantic conventions exist
             "aws.region": call_context.region,
+            **_get_server_attributes(call_context.endpoint_url),
         }
 
         _safe_invoke(extension.extract_attributes, attributes)
@@ -403,3 +405,13 @@ def _safe_invoke(function: Callable, *args):
         logger.error(
             "Error when invoking function '%s'", function_name, exc_info=ex
         )
+
+
+def _get_server_attributes(endpoint_url: str) -> dict[str, str]:
+    """Extract server.* attributes from AWS endpoint URL."""
+    parsed = urlparse(endpoint_url)
+    attributes = {}
+    if parsed.hostname:
+        attributes[SpanAttributes.SERVER_ADDRESS] = parsed.hostname
+        attributes[SpanAttributes.SERVER_PORT] = parsed.port or 443
+    return attributes

instrumentation/opentelemetry-instrumentation-botocore/tests/test_botocore_instrumentation.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import json
+import os
 from unittest.mock import ANY, Mock, patch
 
 import botocore.session
@@ -63,6 +64,9 @@ def _default_span_attributes(self, service: str, operation: str):
             "aws.region": self.region,
             "retry_attempts": 0,
             SpanAttributes.HTTP_STATUS_CODE: 200,
+            # Some services like IAM or STS have a global endpoint and exclude specified region.
+            SpanAttributes.SERVER_ADDRESS: f"{service.lower()}.{'' if self.region == 'aws-global' else self.region + '.'}amazonaws.com",
+            SpanAttributes.SERVER_PORT: 443,
         }
 
     def assert_only_span(self):
@@ -330,6 +334,7 @@ def test_sts_client(self):
         span = self.assert_only_span()
         expected = self._default_span_attributes("STS", "GetCallerIdentity")
         expected["aws.request_id"] = ANY
+        expected[SpanAttributes.SERVER_ADDRESS] = "sts.amazonaws.com"
         # check for exact attribute set to make sure not to leak any sts secrets
         self.assertEqual(expected, dict(span.attributes))
 
@@ -497,3 +502,54 @@ def response_hook(span, service_name, operation_name, result):
                 response_hook_result_attribute_name: 0,
             },
         )
+
+    @mock_aws
+    def test_server_attributes(self):
+        # Test regional endpoint
+        ec2 = self._make_client("ec2")
+        ec2.describe_instances()
+        self.assert_span(
+            "EC2",
+            "DescribeInstances",
+            attributes={
+                SpanAttributes.SERVER_ADDRESS: f"ec2.{self.region}.amazonaws.com",
+                SpanAttributes.SERVER_PORT: 443,
+            },
+        )
+        self.memory_exporter.clear()
+
+        # Test global endpoint
+        iam_global = self._make_client("iam")
+        iam_global.list_users()
+        self.assert_span(
+            "IAM",
+            "ListUsers",
+            attributes={
+                SpanAttributes.SERVER_ADDRESS: "iam.amazonaws.com",
+                SpanAttributes.SERVER_PORT: 443,
+                "aws.region": "aws-global",
+            },
+        )
+
+    @mock_aws
+    def test_server_attributes_with_custom_endpoint(self):
+        with patch.dict(
+            os.environ,
+            {"MOTO_S3_CUSTOM_ENDPOINTS": "https://proxy.amazon.org:2025"},
+        ):
+            s3 = self.session.create_client(
+                "s3",
+                region_name=self.region,
+                endpoint_url="https://proxy.amazon.org:2025",
+            )
+
+            s3.list_buckets()
+
+            self.assert_span(
+                "S3",
+                "ListBuckets",
+                attributes={
+                    SpanAttributes.SERVER_ADDRESS: "proxy.amazon.org",
+                    SpanAttributes.SERVER_PORT: 2025,
+                },
+            )