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.

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

B3 clarification #961

Merged
merged 3 commits into from Sep 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions specification/context/api-propagators.md
Expand Up @@ -315,6 +315,28 @@ organization and MUST be distributed as OpenTelemetry extension packages:
* [B3](https://github.com/openzipkin/b3-propagation)
* [Jaeger](https://www.jaegertracing.io/docs/latest/client-libraries/#propagation-format)

### B3 Requirements

B3 has both single and multi-header encodings. To maximize compatibility between
implementations, the following guidelines have been established for B3
propagation in OpenTelemetry.

#### Extract

Propagators MUST attempt to extract B3 encoded using single and multi-header
formats. When extracting, the single-header variant takes precedence over
the multi-header version.

#### Inject

When injecting B3, propagators:

* MUST default to injecting B3 using the single-header format
* MUST provide configuration to change the default injection format to B3
multi-header

### Vendor-specific propagators

Additional `Propagator`s implementing vendor-specific protocols such as
AWS X-Ray trace header protocol are encouraged to be maintained and distributed by
their respective vendors.