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

Specify the initial propagators requirements. #735

Merged
merged 8 commits into from
Aug 5, 2020
Merged

Specify the initial propagators requirements. #735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f192f26
Specify the initial propagators requirements.
carlosalberto Jul 24, 2020
62836a6
Do not require the SDK to include the B3 protocol.
carlosalberto Jul 27, 2020
3b1c0da
Update specification/trace/api.md
carlosalberto Jul 27, 2020
0f7cc66
Update specification/correlationcontext/api.md
carlosalberto Jul 27, 2020
fd44e8a
Remove the CorrelationContext propagator requirement.
carlosalberto Jul 29, 2020
837897c
Make TraceContext optional in the API.
carlosalberto Jul 30, 2020
e7abd4a
Update the propagators location.
carlosalberto Aug 5, 2020
373a228
Fix typo.
carlosalberto Aug 5, 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
12 changes: 12 additions & 0 deletions specification/context/api-propagators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Table of Contents
- [Get](#get)
- [Composite Propagator](#composite-propagator)
- [Global Propagators](#global-propagators)
- [Propagators Distribution](#propagators-distribution)

</details>

Expand Down Expand Up @@ -266,3 +267,14 @@ Sets the global `Propagator` instance.
Required parameters:

- A `Propagator`. This usually will be a composite instance.

## Propagators Distribution

`Propagator`s implementing officially supported protocols such as
[B3 Propagation Specification](https://github.com/openzipkin/b3-propagation)
MUST be maintained by the OpenTelemetry organization and MUST be distributed as
OpenTelemetry extension packages.

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.
1 change: 1 addition & 0 deletions specification/correlationcontext/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,4 @@ otcorrelations: user=foo%40example.com,name=Example%20Name

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
is replaced with the added value (regardless if it is locally generated or received from a remote peer).

7 changes: 7 additions & 0 deletions specification/trace/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Table of Contents
* [GetIsOk](#getisok)
* [SpanKind](#spankind)
* [Concurrency](#concurrency)
* [Included Propagators](#included-propagators)

</details>

Expand Down Expand Up @@ -687,3 +688,9 @@ implementer of these events.
**Link** - Links are immutable and is safe to be used concurrently. Lazy
initialized links must be thread safe. This is the responsibility of the
implementer of these links.

## Included Propagators

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

* A `HTTPTextPropagator` implementing the [W3C TraceContext Specification](https://www.w3.org/TR/trace-context/).