opentelemetry-exporter-otlp-proto-grpc: permit to override default exporter headers

Author: xrmx

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py

@@ -225,13 +225,17 @@ def __init__(
         self._headers = headers or environ.get(OTEL_EXPORTER_OTLP_HEADERS)
         if isinstance(self._headers, str):
             temp_headers = parse_env_headers(self._headers, liberal=True)
-            self._headers = tuple(temp_headers.items())
-        elif isinstance(self._headers, dict):
-            self._headers = tuple(self._headers.items())
+            self._headers = temp_headers
+        elif isinstance(self._headers, tuple):
+            self._headers = dict(self._headers)
+
         if self._headers is None:
             self._headers = tuple(_OTLP_GRPC_HEADERS)
         else:
-            self._headers = tuple(self._headers) + tuple(_OTLP_GRPC_HEADERS)
+            # let users override our defaults
+            self._headers = tuple(
+                {**dict(_OTLP_GRPC_HEADERS), **self._headers}.items()
+            )
 
         self._timeout = timeout or int(
             environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, 10)

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py

@@ -27,6 +27,7 @@
 from opentelemetry.exporter.otlp.proto.grpc._log_exporter import (
     OTLPLogExporter,
 )
+from opentelemetry.exporter.otlp.proto.grpc.version import __version__
 from opentelemetry.proto.collector.logs.v1.logs_service_pb2 import (
     ExportLogsServiceRequest,
 )
@@ -460,3 +461,37 @@ def test_translate_multiple_logs(self):
                 [self.log_data_1, self.log_data_2, self.log_data_3]
             ),
         )
+
+    @patch(
+        "opentelemetry.exporter.otlp.proto.grpc.exporter.ssl_channel_credentials"
+    )
+    @patch("opentelemetry.exporter.otlp.proto.grpc.exporter.secure_channel")
+    # pylint: disable=unused-argument
+    def test_otlp_headers_overrides_from_env(
+        self, mock_ssl_channel, mock_secure
+    ):
+        exporter = OTLPLogExporter()
+        # pylint: disable=protected-access
+        self.assertEqual(
+            exporter._headers,
+            (("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),),
+        )
+
+        with patch.dict(
+            "os.environ",
+            {OTEL_EXPORTER_OTLP_LOGS_HEADERS: "User-agent=GrpcLogExporter"},
+        ):
+            exporter = OTLPLogExporter()
+            # pylint: disable=protected-access
+            self.assertEqual(
+                exporter._headers,
+                (("user-agent", "GrpcLogExporter"),),
+            )
+            exporter = OTLPLogExporter(
+                headers=(("user-agent", "ParamExporter"),)
+            )
+            # pylint: disable=protected-access
+            self.assertEqual(
+                exporter._headers,
+                (("user-agent", "ParamExporter"),),
+            )

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_metrics_exporter.py

@@ -254,9 +254,9 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
         self.assertEqual(
             exporter._headers,
             (
+                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
                 ("key1", "value1"),
                 ("key2", "VALUE=2"),
-                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
             ),
         )
         exporter = OTLPMetricExporter(
@@ -266,12 +266,39 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
         self.assertEqual(
             exporter._headers,
             (
+                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
                 ("key3", "value3"),
                 ("key4", "value4"),
-                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
             ),
         )
 
+    @patch.dict(
+        "os.environ",
+        {OTEL_EXPORTER_OTLP_METRICS_HEADERS: "User-agent=GrpcMetricsExporter"},
+    )
+    @patch(
+        "opentelemetry.exporter.otlp.proto.grpc.exporter.ssl_channel_credentials"
+    )
+    @patch("opentelemetry.exporter.otlp.proto.grpc.exporter.secure_channel")
+    # pylint: disable=unused-argument
+    def test_otlp_headers_overrides_from_env(
+        self, mock_ssl_channel, mock_secure
+    ):
+        exporter = OTLPMetricExporter()
+        # pylint: disable=protected-access
+        self.assertEqual(
+            exporter._headers,
+            (("user-agent", "GrpcMetricsExporter"),),
+        )
+        exporter = OTLPMetricExporter(
+            headers=(("user-agent", "ParamExporter"),)
+        )
+        # pylint: disable=protected-access
+        self.assertEqual(
+            exporter._headers,
+            (("user-agent", "ParamExporter"),),
+        )
+
     @patch.dict(
         "os.environ",
         {OTEL_EXPORTER_OTLP_METRICS_INSECURE: "True"},

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_trace_exporter.py

@@ -267,7 +267,9 @@ def test_no_credentials_error(
 
     @patch.dict(
         "os.environ",
-        {OTEL_EXPORTER_OTLP_TRACES_HEADERS: " key1=value1,KEY2 = VALUE=2 "},
+        {
+            OTEL_EXPORTER_OTLP_TRACES_HEADERS: " key1=value1,KEY2 = VALUE=2 ,User-agent=GrpcTraceExporter"
+        },
     )
     @patch(
         "opentelemetry.exporter.otlp.proto.grpc.exporter.ssl_channel_credentials"
@@ -280,9 +282,9 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
         self.assertEqual(
             exporter._headers,
             (
+                ("user-agent", "GrpcTraceExporter"),
                 ("key1", "value1"),
                 ("key2", "VALUE=2"),
-                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
             ),
         )
         exporter = OTLPSpanExporter(
@@ -292,21 +294,25 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
         self.assertEqual(
             exporter._headers,
             (
+                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
                 ("key3", "value3"),
                 ("key4", "value4"),
-                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
             ),
         )
         exporter = OTLPSpanExporter(
-            headers={"key5": "value5", "key6": "value6"}
+            headers={
+                "key5": "value5",
+                "key6": "value6",
+                "user-agent": "ParameterExporter",
+            }
         )
         # pylint: disable=protected-access
         self.assertEqual(
             exporter._headers,
             (
+                ("user-agent", "ParameterExporter"),
                 ("key5", "value5"),
                 ("key6", "value6"),
-                ("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
             ),
         )