opentelemetry-specification icon indicating copy to clipboard operation
opentelemetry-specification copied to clipboard

Page feedback - exporter (delimiters)

Open sparecycles opened this issue 1 year ago • 3 comments

Suggested improvements for page: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md

The "Specifying headers via environment variables" section mentions semi-colon delimited values:

The OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_HEADERS, OTEL_EXPORTER_OTLP_METRICS_HEADERS, OTEL_EXPORTER_OTLP_LOGS_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 Baggage, except that additional semi-colon delimited metadata is not supported, i.e.: key1=value1,key2=value2. All attribute values MUST be considered strings.

but the i.e., example is comma-delimited. So is that an example of what to do or what not to do? (that is the question).

Edited by @svrnm to change the URL from opentelemetry.io to the source file in the repo

sparecycles avatar Nov 17 '24 18:11 sparecycles

thanks for raising this issue @sparecycles! Since that file is sourced from the spec repository I will move your issue there

svrnm avatar Nov 18 '24 06:11 svrnm

@sparecycles, please read it another time

these are expected to be represented in a format matching to the W3C Baggage, except that additional semi-colon delimited metadata is not supported

Therefore, it is an example of what to do.

pellared avatar Nov 19 '24 11:11 pellared

I agree it reads a bit confusing, I think a clarification PR would be welcome

trask avatar Nov 19 '24 21:11 trask