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

Remove custom header name for Baggage, use official header #993

Merged
merged 2 commits into from
Sep 25, 2020
Merged

Remove custom header name for Baggage, use official header #993

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9370220
Remove custom header name for Baggage, use official header
bogdandrutu Sep 23, 2020
d83956c
Update specification/context/api-propagators.md
SergeyKanzhelev Sep 24, 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
32 changes: 2 additions & 30 deletions specification/baggage/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Table of Contents
- [Remove baggage](#remove-baggage)
- [Clear](#clear)
- [Baggage Propagation](#baggage-propagation)
- [Serialization](#serialization)
- [Conflict Resolution](#conflict-resolution)

</details>
Expand Down Expand Up @@ -101,36 +100,9 @@ OPTIONAL parameters:
`Baggage` MAY be propagated across process boundaries or across any arbitrary boundaries
(process, $OTHER_BOUNDARY1, $OTHER_BOUNDARY2, etc) for various reasons.

### Serialization
The API layer MAY include the following `Propagator`s:

Until the [W3C Baggage](https://w3c.github.io/baggage/) specification is recommended for use, OpenTelemetry `Baggage` implementations MUST be serialized according to the [editor's draft of W3C Correlation Context as of March 27, 2020](https://github.com/w3c/correlation-context/blob/c974664b9ab4d33af6355f1f7f03a2d52c89a99e/correlation_context/HTTP_HEADER_FORMAT.md) using a vendor-specific header name to avoid collisions with the W3C Baggage specification should it change in the future.

#### Header Name

`Baggage` implementations MUST use the header name `otelbaggage`.

#### Header Value

`Baggage` MUST be serialized according to the [editor's draft of W3C Correlation Context as of September 21, 2020](https://github.com/w3c/baggage/blob/0573bd79c0d93a779145fd26a7b3e532c912c783/baggage/HTTP_HEADER_FORMAT.md).

`Baggage` values MUST be serialized as Percent-Encoded UTF-8 strings according to [RFC 3986 Section 2.1](https://tools.ietf.org/html/rfc3986#section-2.1).

#### Example

Baggage:

```json
{
"user": "[email protected]",
"name": "Example Name"
}
```

Header:

```
otcorrelations: user=foo%40example.com,name=Example%20Name
```
* A `TextMapPropagator` implementing the [W3C Baggage Specification](https://w3c.github.io/baggage).

## Conflict Resolution

Expand Down
2 changes: 1 addition & 1 deletion specification/context/api-propagators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ unconfigured, although the trace context propagation was configured to enrich lo
Platforms such as ASP.NET may pre-configure out-of-the-box
propagators. If pre-configured, `Propagator`s SHOULD default to a composite
`Propagator` containing the W3C Trace Context Propagator and the Baggage
`Propagator` specified in [api-baggage.md](../baggage/api.md#serialization).
`Propagator` specified in [api-baggage.md](../baggage/api.md#baggage-propagation).
These platforms MUST also allow pre-configured propagators to be disabled or overridden.

### Get Global Propagator
Expand Down