Allow specifying OTLP HTTP headers from env variable #1290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lalitb
changed the title
Codecov ReportAttention:
... and 18 files with indirect coverage changes 📢 Thoughts on this report? Let us know!. |
cijothomas
reviewed
Oct 6, 2023
cijothomas
reviewed
Oct 6, 2023
cijothomas
approved these changes
Oct 6, 2023
jtescher
reviewed
Oct 6, 2023
jtescher
approved these changes
Oct 8, 2023
4 tasks
hdost
pushed a commit
that referenced
this pull request
Nov 19, 2023
Fixes #1336 As per the [specs](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.25.0/specification/protocol/exporter.md#specifying-headers-via-environment-variables), the custom headers for OTLP exporter can be specified through env variables - `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_EXPORTER_OTLP_TRACES_HEADERS`, `OTEL_EXPORTER_OTLP_METRICS_HEADERS`. This PR completes the work already done in PR #1290 adding support for tonic metadata To reproduce the same behavior as http exporter, the env-variable takes precedence (as discussed in open-telemetry/opentelemetry-rust-contrib#10) * Move common code for http and tonic exporters in `exporter/mod.rs` (function to parse header from string and test helper to run tests with isolated env variables) I wanted to minimize the changes but maybe it should be a good idea to use a crate like https://crates.io/crates/temp-env for environment related testing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #
Design discussion issue (if applicable) #
Changes
As per the specs, the custom HTTP headers for OTLP exporter can be specified through env variables -
OTEL_EXPORTER_OTLP_HEADERS,OTEL_EXPORTER_OTLP_TRACES_HEADERS,OTEL_EXPORTER_OTLP_METRICS_HEADERS. This PR add the support.The existing implementation supports specifying the header at compile time. And as discussed in #1255, the env-variable takes precedence. Currently in this PR, headers specified through configuration and environment variables are merged, with the environment variable keys overriding existing header keys."
Compiler time:
k1=v1, k2=v2Env variable:
k1=v1_new, k3=v3final:
k1=v1_new, k2=v2, k3=v3As of now, change are only done for HTTP, and not gRPC. The MetadataMap in gRPC
toniccrate only allows to specify metadata headers at compile time (through&'static str), so it seems not possible to populate this structure from env-var.Please provide a brief description of the changes here.
Merge requirement checklist
CHANGELOG.mdfiles updated for non-trivial, user-facing changes