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

Jump to bottom

Trace API: Update mentions of SpanContext as parent. #1023

Merged
merged 6 commits into from
Oct 2, 2020
Merged

Trace API: Update mentions of SpanContext as parent. #1023

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79b09a1
Trace API: Update mentions of SpanContext as parent.
Oberon00 Sep 28, 2020
8e554f5
Incorporate changes regarding Propagated Span
Oberon00 Sep 28, 2020
4164e1d
Rewrite "Behavior of the API in absence of SDK"
Oberon00 Sep 29, 2020
a04b8fc
Update specification/trace/api.md
Oberon00 Sep 30, 2020
76e0d20
Apply suggestions from code review
Oberon00 Sep 30, 2020
67768c7
Improve grammar.
Oberon00 Sep 30, 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
22 changes: 11 additions & 11 deletions specification/trace/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,14 +732,14 @@ The API layer MAY include the following `Propagator`s:

In general, in the absence of an installed SDK, the Trace API is a "no-op" API.
This means that operations on a Tracer, or on Spans, should have no side effects and do nothing. However, there
is one important exception to this general rule, and that is related to propagation of a SpanContext.

The following cases must be considered when a new Span is requested to be created, especially in relation to the
requested parent SpanContext:

* A valid `SpanContext` is specified as the parent of the new `Span`: The API MUST treat this parent context as the
context for the newly created `Span`. This means that a `SpanContext` that has been provided by a configured `Propagator`
will be propagated through to any child span, but that no new `SpanContext`s will be created.
* No valid `SpanContext` is specified as the parent of the new `Span`: The API MUST create an non-valid
(both SpanID and TradeID are equivalent to being all zeros) `Span` for use
by the API caller. This means that both the `TraceID` and the `SpanID` should be invalid.
is one important exception to this general rule, and that is related to propagation of a `SpanContext`:
The API MUST create a [Propagated Span](#propagated-span-creation) with the `SpanContext`
that is in the `Span` in the parent `Context`
(whether explicitly given or implicit current) or
Oberon00 marked this conversation as resolved.
Show resolved Hide resolved
it MAY return the same parent Propagated Span instance back from the creation method, if the parent is a Propagated Span
Oberon00 marked this conversation as resolved.
Show resolved Hide resolved
(which it usually always is if no SDK is present).
If the parent `Context` contains no `Span`, an empty Propagated Span MUST be returend instead
(having a SpanContext with all-zero span and trace ID, empty tracestate, unsampled trace flags)
Oberon00 marked this conversation as resolved.
Show resolved Hide resolved
This means that a `SpanContext` that has been provided by a configured `Propagator`
will be propagated through to any child span and ultimately also `Inject`,
but that no new `SpanContext`s will be created.