Skip to content

Clarify environment carrier key normalization behavior#5102

Merged
carlosalberto merged 14 commits into
open-telemetry:mainfrom
pellared:clarify-env-car
Jun 2, 2026
Merged

Clarify environment carrier key normalization behavior#5102
carlosalberto merged 14 commits into
open-telemetry:mainfrom
pellared:clarify-env-car

Conversation

@pellared
Copy link
Copy Markdown
Member

@pellared pellared commented May 18, 2026

Towards #5040

Changes

Clarifies the environment variable propagation carrier key normalization requirements:

  • Set writes values using normalized key names.
  • Get normalizes both the requested propagator key and carrier keys before matching.
  • Keys returns normalized key names.

Motivation

The existing text defined how key names are normalized, but it did not explicitly say where that normalization applies. This PR clarifies that normalization is part of the carrier behavior for writing, reading, and listing keys.

This follows the robustness principle: carriers write the normalized representation, while getters can still accept a non-normalized environment variable key if it normalizes to the requested propagation key. For example, a non-normalized traceparent environment variable can still be used by the propagation getter when matching TRACEPARENT.

This retrospects #4944 (comment) now that implementations are in place.

Implementation references

Related Java discussion: open-telemetry/opentelemetry-java#8233 (comment)

@pellared
Copy link
Copy Markdown
Member Author

pellared commented May 18, 2026

CC @open-telemetry/semconv-cicd-approvers @jack-berg @marcalff @Joibel

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR clarifies how environment variable propagation carriers apply key normalization during carrier operations, supporting stabilization work for the environment carrier specification.

Changes:

  • Specifies normalization behavior for Set, Get, and Keys.
  • Adds an example showing normalized and non-normalized carrier key matching.
  • Updates the changelog with the clarification.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
specification/context/env-carriers.md Clarifies normalization requirements for carrier read, write, and key listing operations.
CHANGELOG.md Records the environment carrier normalization clarification.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread specification/context/env-carriers.md Outdated
@pellared pellared self-assigned this May 19, 2026
@pellared pellared moved this to In Progress in CI/CD SemConv: Phase 2 May 19, 2026
@carlosalberto carlosalberto added this pull request to the merge queue Jun 2, 2026
Merged via the queue into open-telemetry:main with commit 289d789 Jun 2, 2026
8 of 9 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in CI/CD SemConv: Phase 2 Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

spec:context Related to the specification/context directory

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants