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

Small clean up for Propagators. #577

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
971168e
Small clean up for Propagators.
carlosalberto Apr 27, 2020
445c105
Update specification/context/api-propagators.md
carlosalberto Apr 28, 2020
0dce0df
Update Format/Propagator relationship.
carlosalberto May 1, 2020
33673c5
Fix lint.
carlosalberto May 1, 2020
93e44dc
Do not use Format but Propagator type.
carlosalberto May 4, 2020
9bd2f0d
Update overview.
carlosalberto May 5, 2020
a2639e3
Amend style.
carlosalberto May 5, 2020
02764e4
Merge branch 'master' into clean_up_propagators
carlosalberto May 21, 2020
f99a88f
Add a small explanation on why getter/setters are separate entities.
carlosalberto May 22, 2020
809fa6c
Make getter/setter optional arguments.
carlosalberto Jun 19, 2020
65eebac
More love.
carlosalberto Jun 19, 2020
8b31eb5
More love.
carlosalberto Jul 9, 2020
250967c
Merge branch 'master' into clean_up_propagators
carlosalberto Jul 9, 2020
b44e83c
Update specification/context/api-propagators.md
carlosalberto Jul 9, 2020
46fd93c
Update specification/context/api-propagators.md
carlosalberto Jul 9, 2020
4c6dd1f
Update specification/trace/api.md
carlosalberto Jul 9, 2020
58af0eb
Update specification/context/api-propagators.md
carlosalberto Jul 9, 2020
bdb834f
Update specification/context/api-propagators.md
carlosalberto Jul 9, 2020
8d97361
Remove redundant sections.
carlosalberto Jul 10, 2020
48f3b06
Clarify Setter/Getter.
carlosalberto Jul 10, 2020
a390037
Small mention of what a field is.
carlosalberto Jul 10, 2020
dc659c9
Update specification/context/api-propagators.md
carlosalberto Jul 10, 2020
1297d08
Update CHANGELOG.
carlosalberto Jul 10, 2020
d4022d7
Remove the mention of default `Context` for Injection/Extraction.
carlosalberto Jul 14, 2020
b69ef73
Merge branch 'master' into clean_up_propagators
carlosalberto Jul 16, 2020
c4d4227
Merge branch 'master' into clean_up_propagators
carlosalberto Jul 18, 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
23 changes: 19 additions & 4 deletions specification/context/api-propagators.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Table of Contents
</summary>

- [Overview](#overview)
- [Formats](#formats)
- [Carrier](#carrier)
- [HTTP Text Format](#http-text-format)
- [Fields](#fields)
- [Inject](#inject)
Expand All @@ -32,16 +34,29 @@ cross-cutting concern, such as traces and correlation context.
The Propagators API is expected to be leveraged by users writing
instrumentation libraries.

## Formats

A `Format` defines the restrictions imposed by a specific transport in
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
order to propagate in-band context data across process boundaries.

The Propagators API currently consists of one `Format`:

- `HTTPTextFormat` is used to inject values into and extract values from carriers as text that travel
in-band across process boundaries.
- `HTTPTextFormat` is a format that injects values into and extracts values from carriers as
text.

A binary `Format` will be added in the future.

### Carrier

A carrier is defined as a medium that `Format`s use to read values from and
write values to. Carriers used at[inject](#inject) are expected to be mutable.
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved

Each specific `Format` will define the exact semantics of their related carriers.
Examples of possible carriers are byte buffers or map-alike objects using string values.

## HTTP Text Format

`HTTPTextFormat` is a formatter that injects and extracts a cross-cutting concern
`HTTPTextFormat` is a format that injects and extracts a cross-cutting concern
value as text into carriers that travel in-band across process boundaries.

Encoding is expected to conform to the HTTP Header Field semantics. Values are often encoded as
Expand All @@ -68,7 +83,7 @@ The use cases of this are:
- allow pre-allocation of fields, especially in systems like gRPC Metadata
- allow a single-pass over an iterator

Returns list of fields that will be used by this formatter.
Returns list of fields that will be used by `Propagator`s implementing this `Format`.

### Inject

Expand Down
8 changes: 4 additions & 4 deletions specification/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,11 @@ See the [Context](context/context.md)
## Propagators

OpenTelemetry uses `Propagators` to serialize and deserialize cross-cutting concern values
such as `SpanContext` and `CorrelationContext` into a `Format`. Currently there is one
type of propagator:
such as `SpanContext` and `CorrelationContext` given the restrictions imposed by specific
`Format`s. The Propagators API currently consists of one `Format`:

- `HTTPTextFormat` which is used to inject and extract a value as text into carriers that travel
in-band across process boundaries.
- `HTTPTextFormat` is a format that injects values into and extracts values from carriers as
text.

## Collector

Expand Down