Skip to content

Commit

Permalink
note on vendor specific propagators (#1043)
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeyKanzhelev authored Oct 1, 2020
1 parent a275801 commit 11d26b0
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions specification/context/api-propagators.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,21 @@ 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)

Additional `Propagator`s implementing vendor-specific protocols such as AWS
X-Ray (Note, AWS is used as an example, not as a requirement) trace header
protocol can be either maintained and distributed by their respective vendors or
as part of the OpenTelemetry organization. The reasons for maintaining those as
a community are:

- Propagators are small pieces of code and their functionality is often publicly
documented (unlike exporters).
- People will often need to use propagators that are not specific to their
tracing or metrics vendor. For example, customers of tracing vendor may still
want to use an Cloud vendor-specific propagator for requests to the services
of this cloud vendor.
- Only a small number of propagators will need to exist, and this number will
shrink as vendors and users shift to W3C TraceContext.

### B3 Requirements

B3 has both single and multi-header encodings. To maximize compatibility between
Expand All @@ -334,9 +349,3 @@ 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.

0 comments on commit 11d26b0

Please sign in to comment.