Remove spans with ec2 metadata ip address from metrics

Author: harrryr

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/aws_span_metrics_processor.py

@@ -4,13 +4,15 @@
 
 from typing_extensions import override
 
-from amazon.opentelemetry.distro.metric_attribute_generator import MetricAttributeGenerator
+from amazon.opentelemetry.distro.metric_attribute_generator import MetricAttributeGenerator, DEPENDENCY_METRIC
 from opentelemetry.context import Context
 from opentelemetry.metrics import Histogram
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import BoundedAttributes, ReadableSpan, Span, SpanProcessor, StatusCode
 from opentelemetry.semconv.trace import SpanAttributes
 
+from amazon.opentelemetry.distro._aws_attribute_keys import AWS_REMOTE_SERVICE
+
 _HTTP_STATUS_CODE = SpanAttributes.HTTP_STATUS_CODE
 _NANOS_TO_MILLIS: float = 1_000_000.0
 
@@ -21,6 +23,11 @@
 _FAULT_CODE_UPPER_BOUND: int = 599
 
 
+# EC2 Metadata API IP Address
+# https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html#instancedata-inside-access
+_EC2_METADATA_API_IP: str = "169.254.169.254"
+
+
 class AwsSpanMetricsProcessor(SpanProcessor):
     """AwsSpanMetricsProcessor is SpanProcessor that generates metrics from spans
 
@@ -79,8 +86,10 @@ def on_end(self, span: ReadableSpan) -> None:
         attribute_dict: Dict[str, BoundedAttributes] = self._generator.generate_metric_attributes_dict_from_span(
             span, self._resource
         )
-        for attributes in attribute_dict.values():
-            self._record_metrics(span, attributes)
+
+        if not _is_ec2_metadata_api_span(attribute_dict):
+            for attributes in attribute_dict.values():
+                self._record_metrics(span, attributes)
 
     @override
     def shutdown(self) -> None:
@@ -123,10 +132,12 @@ def _record_latency(self, span: ReadableSpan, attributes: BoundedAttributes) ->
         millis: float = nanos / _NANOS_TO_MILLIS
         self._latency_histogram.record(millis, attributes)
 
-
 def _is_not_error_or_fault(http_status_code: int) -> bool:
     return (
         http_status_code is None
         or http_status_code < _ERROR_CODE_LOWER_BOUND
         or http_status_code > _FAULT_CODE_UPPER_BOUND
     )
+
+def _is_ec2_metadata_api_span(attribute_dict: Dict[str, BoundedAttributes]) -> bool:
+    return attribute_dict.get(DEPENDENCY_METRIC, {}).get(AWS_REMOTE_SERVICE) == _EC2_METADATA_API_IP

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_aws_span_metrics_processor.py

@@ -24,6 +24,9 @@
 from opentelemetry.trace import INVALID_SPAN_CONTEXT, SpanContext, SpanKind
 from opentelemetry.util.types import Attributes
 
+from amazon.opentelemetry.distro._aws_attribute_keys import AWS_REMOTE_SERVICE
+
+
 # Test constants
 _CONTAINS_ATTRIBUTES: bool = True
 _CONTAINS_NO_ATTRIBUTES: bool = False
@@ -238,6 +241,15 @@ def test_on_end_metrics_generation_with_status_data_ok(self):
         self._validate_metrics_generated_for_status_data_ok(599, self.ExpectedStatusMetric.FAULT)
         self._validate_metrics_generated_for_status_data_ok(600, self.ExpectedStatusMetric.NEITHER)
 
+    def test_on_end_metrics_generation_from_ec2_metadata_api(self):
+        span_attributes: Attributes = {AWS_REMOTE_SERVICE: "169.254.169.254"}
+        span: ReadableSpan = _build_readable_span_mock(span_attributes)
+        metric_attributes_dict = _build_ec2_metadata_api_metric_attributes()
+        self._configure_mock_for_on_end(span, metric_attributes_dict)
+
+        self.aws_span_metrics_processor.on_end(span)
+        self._verify_histogram_record(metric_attributes_dict, 0, 0)
+
     def _configure_mock_for_on_end(self, span: Span, attribute_map: {str: Attributes}):
         def generate_m_a_from_span_side_effect(input_span, resource):
             if input_span == span and resource == self.test_resource:
@@ -373,3 +385,9 @@ def _build_metric_attributes(contain_attributes: bool, span: Span) -> Attributes
             attributes = {"new dependency key": "new dependency value"}
             attribute_map[DEPENDENCY_METRIC] = attributes
     return attribute_map
+
+def _build_ec2_metadata_api_metric_attributes() -> Attributes:
+    attribute_map: Attributes = {}
+    attributes = {AWS_REMOTE_SERVICE: "169.254.169.254"}
+    attribute_map[DEPENDENCY_METRIC] = attributes
+    return attribute_map