removed is xray otlp endpoint validation in the span exporter

Author: liustve

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

@@ -9,17 +9,6 @@
 
 _logger: Logger = getLogger(__name__)
 
-XRAY_OTLP_ENDPOINT_PATTERN = r"https://xray\.([a-z0-9-]+)\.amazonaws\.com/v1/traces$"
-
-
-def is_xray_otlp_endpoint(otlp_endpoint: str = None) -> bool:
-    """Is the given endpoint the XRay OTLP endpoint?"""
-
-    if not otlp_endpoint:
-        return False
-
-    return bool(re.match(XRAY_OTLP_ENDPOINT_PATTERN, otlp_endpoint.lower()))
-
 
 def is_installed(req: str) -> bool:
     """Is the given required package installed?"""

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

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # Modifications Copyright The OpenTelemetry Authors. Licensed under the Apache License 2.0 License.
 import os
+import re
 from logging import Logger, getLogger
 from typing import ClassVar, Dict, List, Type, Union
 
@@ -10,7 +11,6 @@
 
 from amazon.opentelemetry.distro._aws_attribute_keys import AWS_LOCAL_SERVICE
 from amazon.opentelemetry.distro._aws_resource_attribute_configurator import get_service_attribute
-from amazon.opentelemetry.distro._utils import is_xray_otlp_endpoint
 from amazon.opentelemetry.distro.always_record_sampler import AlwaysRecordSampler
 from amazon.opentelemetry.distro.attribute_propagating_span_processor_builder import (
     AttributePropagatingSpanProcessorBuilder,
@@ -83,6 +83,7 @@
 OTEL_AWS_PYTHON_DEFER_TO_WORKERS_ENABLED_CONFIG = "OTEL_AWS_PYTHON_DEFER_TO_WORKERS_ENABLED"
 SYSTEM_METRICS_INSTRUMENTATION_SCOPE_NAME = "opentelemetry.instrumentation.system_metrics"
 OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT"
+XRAY_OTLP_ENDPOINT_PATTERN = r"https://xray\.([a-z0-9-]+)\.amazonaws\.com/v1/traces$"
 # UDP package size is not larger than 64KB
 LAMBDA_SPAN_EXPORT_BATCH_SIZE = 10
 
@@ -448,6 +449,15 @@ def _is_lambda_environment():
     return AWS_LAMBDA_FUNCTION_NAME_CONFIG in os.environ
 
 
+def is_xray_otlp_endpoint(otlp_endpoint: str = None) -> bool:
+    """Is the given endpoint the XRay OTLP endpoint?"""
+
+    if not otlp_endpoint:
+        return False
+
+    return bool(re.match(XRAY_OTLP_ENDPOINT_PATTERN, otlp_endpoint.lower()))
+
+
 def _get_metric_export_interval():
     export_interval_millis = float(os.environ.get(METRIC_EXPORT_INTERVAL_CONFIG, DEFAULT_METRIC_EXPORT_INTERVAL))
     _logger.debug("Span Metrics export interval: %s", export_interval_millis)

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

@@ -5,7 +5,7 @@
 
 import requests
 
-from amazon.opentelemetry.distro._utils import is_installed, is_xray_otlp_endpoint
+from amazon.opentelemetry.distro._utils import is_installed
 from opentelemetry.exporter.otlp.proto.http import Compression
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
 
@@ -40,22 +40,24 @@ def __init__(
         # some users might not need to use this exporter. In order not conflict
         # with existing behavior, we check for botocore before initializing this exporter.
 
-        if endpoint and is_xray_otlp_endpoint(endpoint):
+        if endpoint and is_installed("botocore"):
+            # pylint: disable=import-outside-toplevel
+            from botocore import auth, awsrequest, session
 
-            if is_installed("botocore"):
-                # pylint: disable=import-outside-toplevel
-                from botocore import auth, awsrequest, session
+            self.boto_auth = auth
+            self.boto_aws_request = awsrequest
+            self.boto_session = session.Session()
 
-                self.boto_auth = auth
-                self.boto_aws_request = awsrequest
-                self.boto_session = session.Session()
-                self._aws_region = endpoint.split(".")[1]
+            # Assumes only valid endpoints passed are of XRay OTLP format.
+            # The only usecase for this class would be for ADOT Python Auto Instrumentation and that already validates
+            # the endpoint to be an XRay OTLP endpoint.
+            self._aws_region = endpoint.split(".")[1]
 
-            else:
-                _logger.error(
-                    "botocore is required to export traces to %s. Please install it using `pip install botocore`",
-                    endpoint,
-                )
+        else:
+            _logger.error(
+                "botocore is required to export traces to %s. Please install it using `pip install botocore`",
+                endpoint,
+            )
 
         super().__init__(
             endpoint=endpoint,

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

@@ -38,15 +38,6 @@ def setUp(self):
             self.create_span("test_span5", SpanKind.CONSUMER),
         ]
 
-        self.invalid_otlp_tracing_endpoints = [
-            "https://xray.us-east-1.amaz.com/v1/traces",
-            "https://logs.us-east-1.amazonaws.com/v1/logs",
-            "https://test-endpoint123.com/test",
-            "xray.us-east-1.amazonaws.com/v1/traces",
-            "https://test-endpoint123.com/test https://xray.us-east-1.amazonaws.com/v1/traces",
-            "https://xray.us-east-1.amazonaws.com/v1/tracesssda",
-        ]
-
         self.expected_auth_header = "AWS4-HMAC-SHA256 Credential=test_key/some_date/us-east-1/xray/aws4_request"
         self.expected_auth_x_amz_date = "some_date"
         self.expected_auth_security_token = "test_token"
@@ -88,73 +79,6 @@ def test_sigv4_exporter_init_valid_cw_otlp_endpoint(self, session_mock):
         self.assertEqual(exporter._aws_region, "us-east-1")
         self.validate_exporter_extends_http_span_exporter(exporter, OTLP_XRAY_ENDPOINT)
 
-    def test_sigv4_exporter_init_invalid_cw_otlp_endpoint(self):
-        """Tests that the exporter constructor behavior is set by OTLP protobuf/http Span Exporter
-        if an invalid OTLP CloudWatch endpoint is set"""
-        for bad_endpoint in self.invalid_otlp_tracing_endpoints:
-            with self.subTest(endpoint=bad_endpoint):
-                with patch.dict(os.environ, {OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: bad_endpoint}):
-                    exporter = OTLPAwsSpanExporter(endpoint=bad_endpoint)
-                    self.validate_exporter_extends_http_span_exporter(exporter, bad_endpoint)
-
-                    self.assertIsNone(exporter._aws_region)
-
-    @patch("requests.Session.post")
-    @patch("botocore.auth.SigV4Auth.add_auth")
-    @patch("botocore.session.Session")
-    def test_sigv4_exporter_export_does_not_add_sigv4_if_not_valid_cw_endpoint(
-        self, botocore_mock, mock_sigv4_auth, requests_mock
-    ):
-        """Tests that if the OTLP endpoint is not a valid XRay endpoint but the credentials are valid,
-        SigV4 authentication method is called but fails so NO headers are injected into the existing Session headers."""
-
-        # Setting the exporter response
-        mock_response = MagicMock()
-        mock_response.status_code = 200
-        type(mock_response).ok = PropertyMock(return_value=True)
-
-        # Setting the request session headers to make the call to endpoint
-        mock_session = MagicMock()
-        mock_session.headers = {"User-Agent": USER_AGENT, "Content-Type": CONTENT_TYPE}
-        requests_mock.return_value = mock_session
-        mock_session.post.return_value = mock_response
-
-        # SigV4 mock authentication injection
-        mock_sigv4_auth.side_effect = self.mock_add_auth
-
-        mock_botocore_session = MagicMock()
-        botocore_mock.return_value = mock_botocore_session
-
-        mock_botocore_session.get_credentials.return_value = Credentials(
-            access_key="test_key", secret_key="test_secret", token="test_token"
-        )
-
-        # For each invalid CW OTLP endpoint, validate that SigV4 is not injected
-        self.invalid_otlp_tracing_endpoints.append("https://xray.bad-region-1.amazonaws.com/v1/traces")
-        for bad_endpoint in self.invalid_otlp_tracing_endpoints:
-            with self.subTest(endpoint=bad_endpoint):
-                with patch.dict(os.environ, {OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: bad_endpoint}):
-
-                    exporter = OTLPAwsSpanExporter(endpoint=bad_endpoint)
-
-                    self.validate_exporter_extends_http_span_exporter(exporter, bad_endpoint)
-
-                    exporter.export(self.testing_spans)
-
-                    # Verify that SigV4 request headers were not injected
-                    actual_headers = mock_session.headers
-                    self.assertNotIn(AUTHORIZATION_HEADER, actual_headers)
-                    self.assertNotIn(X_AMZ_DATE_HEADER, actual_headers)
-                    self.assertNotIn(X_AMZ_SECURITY_TOKEN_HEADER, actual_headers)
-
-                    requests_mock.assert_called_with(
-                        url=bad_endpoint,
-                        data=ANY,
-                        verify=ANY,
-                        timeout=ANY,
-                        cert=ANY,
-                    )
-
     @patch("botocore.session.Session")
     @patch("requests.Session")
     @patch("botocore.auth.SigV4Auth.add_auth")