Skip to content

Commit

Permalink
Update Baggage propagator to reference API Propagators (open-telemetr…
Browse files Browse the repository at this point in the history
…y#1575)

* Update Baggage propagator to ref API Propagators

The current notes in the Baggage API contradict how the API Propagators
Operation section specifies how failure to extract/inject should not
clear any pre-existing Baggage. This removes the notes and instead links
to the relevant section of the API Propagators.
  • Loading branch information
MrAlias authored Mar 24, 2021
1 parent dc73e7d commit 7027ebe
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ release.
- Define the fallback tracer name for invalid values.
([#1534](https://github.com/open-telemetry/opentelemetry-specification/pull/1534))
- Remove the Included Propagators section from trace API specification that was a duplicate of the Propagators Distribution of the context specification. ([#1556](https://github.com/open-telemetry/opentelemetry-specification/pull/1556))
- Remove the Baggage API propagator notes that conflict with the API Propagators Operations section and fix [#1526](https://github.com/open-telemetry/opentelemetry-specification/issues/1526). ([#1575](https://github.com/open-telemetry/opentelemetry-specification/pull/1575))

### Metrics

Expand Down
11 changes: 3 additions & 8 deletions specification/baggage/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,9 @@ to the optional metadata.

On `extract`, the propagator should store all metadata as a single metadata instance per entry.
On `inject`, the propagator should append the metadata per the W3C specification format.

Notes:

If the propagator is unable to parse the incoming `baggage`, `extract` MUST return
a `Context` with no baggage entries in it.

If the incoming `baggage` is present, but contains no entries, `extract` MUST
return a `Context` with no baggage entries in it.
Refer to the API Propagators
[Operation](../context/api-propagators.md#operations) section for the
additional requirements these operations need to follow.

## Conflict Resolution

Expand Down

0 comments on commit 7027ebe

Please sign in to comment.