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

Describe association between Sampler and TracerProvider. #932

Merged
merged 6 commits into from
Sep 11, 2020
Merged

Describe association between Sampler and TracerProvider. #932

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f1e51f7
Describe association between Sampler and TracerProvider.
Oberon00 Sep 9, 2020
31bb956
Line breaks, ()
Oberon00 Sep 9, 2020
b7bf4e9
Remove trailing spaces
Oberon00 Sep 9, 2020
e216f02
Merge branch 'master' into tracerprovider-sampler
Oberon00 Sep 9, 2020
e608715
Merge branch 'master' into tracerprovider-sampler
arminru Sep 10, 2020
8cebcfd
Merge branch 'master' into tracerprovider-sampler
Oberon00 Sep 11, 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
10 changes: 9 additions & 1 deletion specification/trace/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ The flag combination `SampledFlag == true` and `IsRecording == false`
could cause gaps in the distributed trace, and because of this OpenTelemetry API
MUST NOT allow this combination.

<a name="recording-sampled-reaction-table"></a>

The following table summarizes the expected behavior for each combination of
`IsRecording` and `SampledFlag`.

Expand All @@ -56,7 +58,13 @@ The following table summarizes the expected behavior for each combination of
| false | false | false | false |

The SDK defines the interface [`Sampler`](#sampler) as well as a set of
[built-in samplers](#built-in-samplers).
[built-in samplers](#built-in-samplers) and associates a `Sampler` with each [`TracerProvider`].

When asked to create a Span, the SDK MUST query the `Sampler`'s [`ShouldSample`](#shouldsample) method before actually creating the span, and act accordingly:
see description of [`ShouldSample`'s](#shouldsample) return value below for how to set `IsRecording` and `Sampled` on the Span,
and the [table above](#recording-sampled-reaction-table) on whether to pass the `Span` to `SpanProcessor`s.
A non-recording span MAY be implemented using the same mechanism as when a `Span` is created with no API-implementation installed
(sometimes called a `NoOpSpan` or `DefaultSpan`).

### Sampler

Expand Down