default to gzip compression

Author: liustve

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

@@ -27,6 +27,7 @@
 from amazon.opentelemetry.distro.scope_based_exporter import ScopeBasedPeriodicExportingMetricReader
 from amazon.opentelemetry.distro.scope_based_filtering_view import ScopeBasedRetainingView
 from opentelemetry._logs import set_logger_provider
+from opentelemetry.exporter.otlp.proto.http import Compression
 from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
 from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter as OTLPHttpOTLPMetricExporter
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
@@ -186,7 +187,7 @@ def _init_logging(
 
     for _, exporter_class in exporters.items():
         exporter_args: Dict[str, any] = {}
-        log_exporter = _customize_logs_exporter(exporter_class(**exporter_args), resource)
+        log_exporter = _customize_logs_exporter(exporter_class(**exporter_args))
         provider.add_log_record_processor(BatchLogRecordProcessor(exporter=log_exporter))
 
     handler = LoggingHandler(level=NOTSET, logger_provider=provider)
@@ -359,7 +360,8 @@ def _customize_span_exporter(span_exporter: SpanExporter, resource: Resource) ->
 
         if isinstance(span_exporter, OTLPSpanExporter):
             span_exporter = OTLPSpanExporter(
-                endpoint=traces_endpoint, session=AwsAuthSession(traces_endpoint.split(".")[1], "xray")
+                endpoint=traces_endpoint,
+                session=AwsAuthSession(traces_endpoint.split(".")[1], "xray"),
             )
 
         else:
@@ -374,14 +376,18 @@ def _customize_span_exporter(span_exporter: SpanExporter, resource: Resource) ->
     return AwsMetricAttributesSpanExporterBuilder(span_exporter, resource).build()
 
 
-def _customize_logs_exporter(log_exporter: LogExporter, resource: Resource) -> LogExporter:
+def _customize_logs_exporter(log_exporter: LogExporter) -> LogExporter:
     logs_endpoint = os.environ.get(OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
 
     if is_aws_otlp_endpoint(logs_endpoint, "logs"):
         _logger.info("Detected using AWS OTLP Logs Endpoint.")
 
         if isinstance(log_exporter, OTLPLogExporter) and validate_logs_headers():
-            return OTLPLogExporter(endpoint=logs_endpoint, session=AwsAuthSession(logs_endpoint.split(".")[1], "logs"))
+            return OTLPLogExporter(
+                endpoint=logs_endpoint,
+                compression=Compression.Gzip,
+                session=AwsAuthSession(logs_endpoint.split(".")[1], "logs"),
+            )
 
         _logger.warning(
             "Improper configuration see: please export/set "
@@ -539,8 +545,10 @@ def validate_logs_headers() -> bool:
 
     for pair in logs_headers.split(","):
         if "=" in pair:
-            key = pair.split("=", 1)[0]
-            if key == AWS_OTLP_LOGS_GROUP_HEADER or key == AWS_OTLP_LOGS_STREAM_HEADER:
+            split = pair.split("=", 1)
+            key = split[0]
+            value = split[1]
+            if (key == AWS_OTLP_LOGS_GROUP_HEADER or key == AWS_OTLP_LOGS_STREAM_HEADER) and value:
                 filtered_log_headers_count += 1
 
     if filtered_log_headers_count != 2:

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

@@ -7,14 +7,10 @@
 from botocore.credentials import Credentials
 
 from amazon.opentelemetry.distro.exporter.otlp.aws.common.aws_auth_session import AwsAuthSession
-from opentelemetry.exporter.otlp.proto.http.trace_exporter import DEFAULT_COMPRESSION, DEFAULT_TIMEOUT
-from opentelemetry.exporter.otlp.proto.http.version import __version__
 
 AWS_OTLP_TRACES_ENDPOINT = "https://xray.us-east-1.amazonaws.com/v1/traces"
 AWS_OTLP_LOGS_ENDPOINT = "https://logs.us-east-1.amazonaws.com/v1/logs"
 
-USER_AGENT = "OTel-OTLP-Exporter-Python/" + __version__
-CONTENT_TYPE = "application/x-protobuf"
 AUTHORIZATION_HEADER = "Authorization"
 X_AMZ_DATE_HEADER = "X-Amz-Date"
 X_AMZ_SECURITY_TOKEN_HEADER = "X-Amz-Security-Token"
@@ -65,20 +61,3 @@ def test_aws_auth_session(self, _, __):
         self.assertIn(AUTHORIZATION_HEADER, actual_headers)
         self.assertIn(X_AMZ_DATE_HEADER, actual_headers)
         self.assertIn(X_AMZ_SECURITY_TOKEN_HEADER, actual_headers)
-
-    def validate_exporter_extends_http_exporter(self, exporter, endpoint, exporter_type):
-        self.assertIsInstance(exporter, exporter_type)
-        self.assertIsInstance(exporter._session, AwsAuthSession)
-        self.assertEqual(exporter._endpoint, endpoint)
-        self.assertEqual(exporter._certificate_file, True)
-        self.assertEqual(exporter._client_certificate_file, None)
-        self.assertEqual(exporter._client_key_file, None)
-        self.assertEqual(exporter._timeout, DEFAULT_TIMEOUT)
-        self.assertIs(exporter._compression, DEFAULT_COMPRESSION)
-        self.assertEqual(exporter._headers, {})
-        self.assertIn("User-Agent", exporter._session.headers)
-        self.assertEqual(
-            exporter._session.headers.get("Content-Type"),
-            CONTENT_TYPE,
-        )
-        self.assertEqual(exporter._session.headers.get("User-Agent"), USER_AGENT)

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

@@ -44,6 +44,7 @@
 from opentelemetry.exporter.otlp.proto.grpc._log_exporter import OTLPLogExporter as OTLPGrpcLogExporter
 from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter as OTLPGrpcOTLPMetricExporter
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter as OTLPGrpcSpanExporter
+from opentelemetry.exporter.otlp.proto.http import Compression
 from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
 from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter as OTLPHttpOTLPMetricExporter
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
@@ -372,18 +373,29 @@ def test_customize_span_exporter_sigv4(self):
             bad_configs.append(config)
 
         for config in good_configs:
-            self.customize_exporter_test(config, OTLPSpanExporter(), _customize_span_exporter, OTLPSpanExporter, True)
+            self.customize_exporter_test(
+                config,
+                _customize_span_exporter,
+                OTLPSpanExporter,
+                AwsAuthSession,
+                Compression.NoCompression,
+                OTLPSpanExporter(),
+                Resource.get_empty(),
+            )
+
         for config in bad_configs:
-            self.customize_exporter_test(config, OTLPSpanExporter(), _customize_span_exporter, OTLPSpanExporter, False)
-
-        self.customize_exporter_test(
-            {
-                OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: "https://xray.us-east-1.amazonaws.com/v1/traces",
-            },
-            OTLPGrpcSpanExporter(),
-            _customize_span_exporter,
-            OTLPGrpcSpanExporter,
-            False,
+            self.customize_exporter_test(
+                config,
+                _customize_span_exporter,
+                OTLPSpanExporter,
+                Session,
+                Compression.NoCompression,
+                OTLPSpanExporter(),
+                Resource.get_empty(),
+            )
+
+        self.assertIsInstance(
+            _customize_span_exporter(OTLPGrpcSpanExporter(), Resource.get_empty()), OTLPGrpcSpanExporter
         )
 
     def test_customize_logs_exporter_sigv4(self):
@@ -415,7 +427,6 @@ def test_customize_logs_exporter_sigv4(self):
             "https://logs.amazonaws.com/v1/logs",
             "https://logs.us-east-1.amazon.com/v1/logs",
             "https://logs.us-east-1.aws.com/v1/logs",
-            "https://logs.US-EAST-1.amazonaws.com/v1/logs",
             "https://logs.us_east_1.amazonaws.com/v1/logs",
             "https://logs.us.east.1.amazonaws.com/v1/logs",
             "https://logs..amazonaws.com/v1/logs",
@@ -430,8 +441,6 @@ def test_customize_logs_exporter_sigv4(self):
             "https://logs.us-east-1.amazonaws.com:443/v1/logs",
             "https:/logs.us-east-1.amazonaws.com/v1/logs",
             "https:://logs.us-east-1.amazonaws.com/v1/logs",
-            "https://LOGS.us-east-1.amazonaws.com/v1/logs",
-            "https://logs.us-east-1.amazonaws.com/V1/LOGS",
             "https://logs.us-east-1.amazonaws.com/v1/logging",
             "https://logs.us-east-1.amazonaws.com/v1/cloudwatchlogs",
             "https://logs.us-east-1.amazonaws.com/v1/cwlogs",
@@ -472,20 +481,16 @@ def test_customize_logs_exporter_sigv4(self):
             bad_configs.append(config)
 
         for config in good_configs:
-            self.customize_exporter_test(config, OTLPLogExporter(), _customize_logs_exporter, OTLPLogExporter, True)
+            self.customize_exporter_test(
+                config, _customize_logs_exporter, OTLPLogExporter, AwsAuthSession, Compression.Gzip, OTLPLogExporter()
+            )
+
         for config in bad_configs:
-            self.customize_exporter_test(config, OTLPLogExporter(), _customize_logs_exporter, OTLPLogExporter, False)
+            self.customize_exporter_test(
+                config, _customize_logs_exporter, OTLPLogExporter, Session, Compression.NoCompression, OTLPLogExporter()
+            )
 
-        self.customize_exporter_test(
-            {
-                OTEL_EXPORTER_OTLP_LOGS_ENDPOINT: "https://logs.us-east-1.amazonaws.com/v1/logs",
-                OTEL_EXPORTER_OTLP_LOGS_HEADERS: "x-aws-log-group=test,x-aws-log-stream=test",
-            },
-            OTLPGrpcLogExporter(),
-            _customize_logs_exporter,
-            OTLPGrpcLogExporter,
-            False,
-        )
+        self.assertIsInstance(_customize_logs_exporter(OTLPGrpcLogExporter()), OTLPGrpcLogExporter)
 
     def test_init_logging(self):
         captured_exporter = None
@@ -497,10 +502,9 @@ def capture_exporter(*args, **kwargs):
             return result
 
         test_cases = [
-            [{"otlp": OTLPLogExporter}, [OTLPLogExporter]],
-            [{"otlp": OTLPLogExporter, "grpc": OTLPGrpcLogExporter}, [OTLPLogExporter, OTLPGrpcLogExporter]],
-            [{}, [OTLPLogExporter]],
-            [{"grpc": OTLPGrpcLogExporter}, [OTLPGrpcLogExporter]],
+            [{"otlp": OTLPLogExporter}, OTLPLogExporter],
+            [{}, OTLPLogExporter],
+            [{"grpc": OTLPGrpcLogExporter}, OTLPGrpcLogExporter],
         ]
 
         os.environ[OTEL_EXPORTER_OTLP_LOGS_ENDPOINT] = "https://logs.us-east-1.amazonaws.com/v1/logs"
@@ -511,20 +515,14 @@ def capture_exporter(*args, **kwargs):
 
             mock_customize_logs_exporter.side_effect = capture_exporter
 
-            for i in range(len(test_cases)):
-                exporters_dict = test_cases[i][0]
-                expected_exporters = test_cases[i][1]
-
-                _init_logging(exporters_dict, Resource.get_empty())
-
-                args_list = mock_customize_logs_exporter.call_args_list
+            for tc in test_cases:
+                exporter_dict = tc[0]
+                expected_exporter = tc[1]
+                _init_logging(exporter_dict, Resource.get_empty())
 
-                self.assertEquals(len(expected_exporters), len(args_list))
+                self.assertIsInstance(captured_exporter, expected_exporter)
 
-                for j in range(len(expected_exporters)):
-                    self.assertIsInstance(args_list[j].args[0], expected_exporters[j])
-
-                mock_customize_logs_exporter.reset_mock()
+        os.environ.pop(OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
 
     def test_customize_span_processors(self):
         mock_tracer_provider: TracerProvider = MagicMock()
@@ -666,20 +664,16 @@ def test_customize_metric_exporter(self):
         os.environ.pop("OTEL_METRIC_EXPORT_INTERVAL", None)
 
     def customize_exporter_test(
-        self, config, default_exporter, executor, expected_exporter_type, has_aws_authenticator
+        self, config, executor, expected_exporter_type, expected_session, expected_compression, *args
     ):
         for key, value in config.items():
             os.environ[key] = value
 
         try:
-            result = executor(default_exporter, Resource.get_empty())
+            result = executor(*args)
             self.assertIsInstance(result, expected_exporter_type)
-
-            if has_aws_authenticator:
-                self.assertIsInstance(result._session, AwsAuthSession)
-            else:
-                self.assertTrue(not hasattr(result, "_session") or isinstance(result._session, Session))
-
+            self.assertIsInstance(result._session, expected_session)
+            self.assertEqual(result._compression, expected_compression)
         finally:
             for key in config.keys():
                 os.environ.pop(key, None)