Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

exporter: Clarify headers formatting #3757

Closed
pellared opened this issue Nov 6, 2023 · 1 comment · Fixed by #3765
Closed

exporter: Clarify headers formatting #3757

pellared opened this issue Nov 6, 2023 · 1 comment · Fixed by #3765
Assignees
Labels
area:configuration Related to configuring the SDK spec:protocol Related to the specification/protocol directory

Comments

@pellared
Copy link
Member

pellared commented Nov 6, 2023

What are you trying to achieve?

Clarify https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specifying-headers-via-environment-variables:

The OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS environment variables will contain a list of key value pairs, and these are expected to be represented in a format matching to the W3C Correlation-Context, except that additional semi-colon delimited metadata is not supported, i.e.: key1=value1,key2=value2. All attribute values MUST be considered strings.

What did you expect to see?

Clear definition on the formatting.

Referring to quoting "W3C Correlation-Context" is bad because:

  1. it does not refer to any stable specification (it even points to a master branch not even e.g. https://www.w3.org/TR/baggage/#baggage-http-header-format)
  2. the name seems bad

Maybe it should be a format like a value of tracestate from the Trace Context W3C specification? See: https://www.w3.org/TR/trace-context/#tracestate-header-field-values?

Or should it be https://www.w3.org/TR/baggage/#header-content?

@pellared pellared added the spec:protocol Related to the specification/protocol directory label Nov 6, 2023
@arminru arminru added the area:configuration Related to configuring the SDK label Nov 14, 2023
@pellared
Copy link
Member Author

pellared commented Nov 14, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:configuration Related to configuring the SDK spec:protocol Related to the specification/protocol directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants