add headers_list support, similar to attributes_list (#122)

Signed-off-by: Alex Boten <[email protected]>
open-telemetry · Sep 17, 2024 · a377d99 · a377d99
1 parent 2a69092
commit a377d99
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml
@@ -79,6 +79,10 @@ logger_provider:
             # Environment variable: OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_LOGS_HEADERS
             headers:
               api-key: "1234"
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_LOGS_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: "api-key=1234"
             # Configure compression.
             #
             # Environment variable: OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_LOGS_COMPRESSION
@@ -187,6 +191,10 @@ meter_provider:
             # Environment variable: OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS
             headers:
               api-key: !!str 1234
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: "api-key=1234"
             # Configure compression.
             #
             # Environment variable: OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
@@ -314,6 +322,10 @@ tracer_provider:
             # Environment variable: OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS
             headers:
               api-key: !!str 1234
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: "api-key=1234"
             # Configure compression.
             #
             # Environment variable: OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_TRACES_COMPRESSION

diff --git a/examples/sdk-migration-config.yaml b/examples/sdk-migration-config.yaml
@@ -32,7 +32,6 @@
 # - OTEL_EXPORTER_OTLP_CERTIFICATE
 # - OTEL_EXPORTER_OTLP_CLIENT_KEY
 # - OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE
-# - OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_{SIGNAL}_HEADERS
 # - OTEL_EXPORTER_OTLP_COMPRESSION
 # - OTEL_EXPORTER_OTLP_TIMEOUT
 
@@ -98,6 +97,10 @@ tracer_provider:
             timeout: ${OTEL_EXPORTER_OTLP_TRACES_TIMEOUT:-10000}
             # Configure headers:
             headers: {}
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: ${OTEL_EXPORTER_OTLP_TRACES_HEADERS}
   # Configure span limits. See also attribute_limits.
   limits:
     # Configure max span attribute value size. Overrides attribute_limits.attribute_value_length_limit.
@@ -167,6 +170,10 @@ meter_provider:
             timeout: ${OTEL_EXPORTER_OTLP_METRICS_TIMEOUT:-10000}
             # Configure headers:
             headers: {}
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: "{OTEL_EXPORTER_OTLP_METRICS_HEADERS}"
             # Configure temporality preference.
             temporality_preference: ${OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE:-cumulative}
             # Configure default histogram aggregation.
@@ -206,6 +213,10 @@ logger_provider:
             timeout: ${OTEL_EXPORTER_OTLP_LOGS_TIMEOUT:-10000}
             # Configure headers:
             headers: {}
+            # Configure headers. Entries have lower priority than entries from .headers.
+            #
+            # The value is a list of comma separated key-value pairs,  matching the format of OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_LOGS_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
+            headers_list: "{OTEL_EXPORTER_OTLP_LOGS_HEADERS}"
   # Configure log record limits. See also attribute_limits.
   limits:
     # Configure max log record attribute value size. Overrides attribute_limits.attribute_value_length_limit.

diff --git a/schema/common.json b/schema/common.json
@@ -66,6 +66,9 @@
                 "headers": {
                     "$ref": "#/$defs/Headers"
                 },
+                "headers_list": {
+                    "type": ["string", "null"]
+                },
                 "compression": {
                     "type": ["string", "null"]
                 },

diff --git a/schema/meter_provider.json b/schema/meter_provider.json
@@ -172,6 +172,9 @@
                 "headers": {
                     "$ref": "common.json#/$defs/Headers"
                 },
+                "headers_list": {
+                    "type": ["string", "null"]
+                },
                 "compression": {
                     "type": ["string", "null"]
                 },