Skip to content

Commit 1928a18

Browse files
MrAliasarminrucarlosalberto
authored
Clarify composite inject/extract optional arguments (open-telemetry#1541)
Co-authored-by: Armin Ruech <[email protected]> Co-authored-by: Carlos Alberto Cortez <[email protected]>
1 parent 69c3fc7 commit 1928a18

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ release.
77

88
## Unreleased
99

10+
### Context
11+
12+
- Clarify composite `TextMapPropagator` method required and optional arguments. ([#1541](https://github.com/open-telemetry/opentelemetry-specification/pull/1541))
13+
1014
### Traces
1115

1216
- Add `ForceFlush` to `Span Exporter` interface ([#1467](https://github.com/open-telemetry/opentelemetry-specification/pull/1467))

specification/context/api-propagators.md

+6
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,9 @@ Required arguments:
266266

267267
- A `Context`.
268268
- The carrier that holds propagation fields.
269+
270+
If the `TextMapPropagator`'s `Extract` implementation accepts the optional `Getter` argument, the following arguments are REQUIRED, otherwise they are OPTIONAL:
271+
269272
- The instance of `Getter` invoked for each propagation key to get.
270273

271274
### Composite Inject
@@ -274,6 +277,9 @@ Required arguments:
274277

275278
- A `Context`.
276279
- The carrier that holds propagation fields.
280+
281+
If the `TextMapPropagator`'s `Inject` implementation accepts the optional `Setter` argument, the following arguments are REQUIRED, otherwise they are OPTIONAL:
282+
277283
- The `Setter` to set a propagation key/value pair. Propagators MAY invoke it multiple times in order to set multiple pairs.
278284

279285
## Global Propagators

0 commit comments

Comments
 (0)