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.

Sign up for GitHub

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

Update the baggage spec to include opaque metadata. #1066

Merged
merged 7 commits into from
Oct 9, 2020
Merged

Update the baggage spec to include opaque metadata. #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cfa058a
Update the baggage spec to include opaque metadata.
jkwatson Oct 6, 2020
b158c36
fix CHANGELOG update
jkwatson Oct 6, 2020
a04d2f2
Add clarification that the Metadata should be an opaque wrapper for t…
jkwatson Oct 6, 2020
edfdb53
Update CHANGELOG.md
jkwatson Oct 7, 2020
e167f77
Add some additional baggage propagator implementation notes.
jkwatson Oct 7, 2020
51caf31
update name/value description, based on feedback
jkwatson Oct 7, 2020
9899958
update CHANGELOG.md from rebase
jkwatson Oct 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ release.

New:

- Add Metadata for Baggage entries, and clarify W3C Baggage Propagator implementation
([#1066](https://github.com/open-telemetry/opentelemetry-specification/pull/1066))
- Change Status to be consistent with Link and Event
([#1067](https://github.com/open-telemetry/opentelemetry-specification/pull/1067))
- Clarify env variables in otlp exporter
Expand Down
21 changes: 18 additions & 3 deletions specification/baggage/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,16 @@ contains a `Baggage` with the new value.

REQUIRED parameters:

`Name` the name for which to set the value.
`Name` The name for which to set the value, of type string.

`Value` the value to set.
`Value` The value to set, of type string.

OPTIONAL parameters:

`Context` the context containing the `Baggage` in which to set the baggage entry.
`Metadata` Optional metadata associated with the name-value pair. This should be an opaque wrapper
for a string with no semantic meaning. Left opaque to allow for future functionality.
jkwatson marked this conversation as resolved.
Show resolved Hide resolved

`Context` The context containing the `Baggage` in which to set the baggage entry.

### Remove baggage

Expand Down Expand Up @@ -104,6 +107,18 @@ The API layer MAY include the following `Propagator`s:

* A `TextMapPropagator` implementing the [W3C Baggage Specification](https://w3c.github.io/baggage).

Note: The W3C baggage specification does not currently assign semantic meaning 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 `baggage` header, `extract` MUST return a Context with no baggage entries in it.

If the `baggage` header is present, but contains no entries, `extract` MUST return a Context with
no baggage entries in it.

## Conflict Resolution

If a new name/value pair is added and its name is the same as an existing name, than the new pair MUST take precedence. The value
Expand Down