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

Add details for determining the parent Span from a Context #423

Merged
merged 9 commits into from
Jan 28, 2020
Merged

Add details for determining the parent Span from a Context #423

Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
546a16e
Add details for parenting a span from a context
mwear Jan 25, 2020
ed3200a
Integrate suggested feedback
mwear Jan 25, 2020
3a73298
Apply suggestion
mwear Jan 25, 2020
4de3159
Apply suggestion
mwear Jan 25, 2020
67949f0
Apply suggestion
mwear Jan 25, 2020
9d6fc6a
Add comma
mwear Jan 27, 2020
83145b4
Rephrase parenting a span
mwear Jan 27, 2020
c65a08c
Fix broken link
mwear Jan 27, 2020
9075ad9
Merge branch 'master' into context_prop_span_parentage_updates
bogdandrutu Jan 28, 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
24 changes: 21 additions & 3 deletions specification/api-tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Table of Contents
* [SpanContext](#spancontext)
* [Span](#span)
* [Span creation](#span-creation)
* [Determining the Parent Span from a Context](#determining-the-parent-span-from-a-context)
* [Add Links](#add-links)
* [Span operations](#span-operations)
* [Get Context](#get-context)
Expand Down Expand Up @@ -257,9 +258,11 @@ as a separate operation.
The API MUST accept the following parameters:

- The span name. This is a required parameter.
- The parent Span or parent Span context, and whether the new `Span` should be a
root `Span`. API MAY also have an option for implicit parent context
extraction from the current context as a default behavior.
- The parent `Span` or a `Context` containing a parent `Span` or `SpanContext`,
mwear marked this conversation as resolved.
Show resolved Hide resolved
and whether the new `Span` should be a root `Span`. API MAY also have an
option for implicit parenting from the current context as a default behavior.
See [Determining the Parent Span from a Context](#determining-the-parent-span-from-a-context)
for guidance on `Span` parenting from explicit and implicit `Context`s.
- [`SpanKind`](#spankind), default to `SpanKind.Internal` if not specified.
- `Attribute`s - A collection of key-value pairs, with the same semantics as
the ones settable with [Span::SetAttributes](#set-attributes). Additionally,
Expand Down Expand Up @@ -290,6 +293,21 @@ created in another process. Each propagators' deserialization must set
`IsRemote` to true on a parent `SpanContext` so `Span` creation knows if the
parent is remote.

#### Determining the Parent Span from a Context

When a new `Span` is created from a `Context`, the `Context` may contain:

- A current `Span`
- An extracted `SpanContext`
- A current `Span` and an extracted `SpanContext`
- Neither a current `Span` nor an extracted `Span` context

The parent should be selected in the following order of precedence:

- Use the current `Span`, if available.
- Use the extracted `SpanContext`, if available.
- There is no parent. Create a root `Span`.

#### Add Links

During the `Span` creation user MUST have the ability to record links to other `Span`s. Linked
Expand Down