Skip to content

docs: fix links & headings about built-in samplers #2011

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

Merged
vmarchaud merged 3 commits into from
Mar 13, 2021
Merged

docs: fix links & headings about built-in samplers #2011

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d334285
docs: fix links & headings about bult-in samplers
pokutuna Mar 11, 2021
aa237e4
Merge branch 'main' into fix-sampler-link
pokutuna Mar 12, 2021
d87ca0c
Merge branch 'main' into fix-sampler-link
vmarchaud Mar 13, 2021
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
15 changes: 8 additions & 7 deletions packages/opentelemetry-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ This package provides default implementations of the OpenTelemetry API for trace
- [Composite Propagator](#composite-propagator)
- [Baggage Propagator](#baggage-propagator)
- [Built-in Sampler](#built-in-sampler)
- [Always Sampler](#always-sampler)
- [Never Sampler](#never-sampler)
- [Probability Sampler](#probability-sampler)
- [AlwaysOn Sampler](#alwayson-sampler)
- [AlwaysOff Sampler](#alwaysoff-sampler)
- [TraceIdRatioBased Sampler](#traceidratiobased-sampler)
- [ParentBased Sampler](#parentbased-sampler)
- [Useful links](#useful-links)
- [License](#license)

Expand Down Expand Up @@ -66,7 +67,7 @@ api.propagation.setGlobalPropagator(new HttpBaggage());

Sampler is used to make decisions on `Span` sampling.

#### AlwaysOn
#### AlwaysOn Sampler

Samples every trace regardless of upstream sampling decisions.

Expand All @@ -81,7 +82,7 @@ const tracerProvider = new NodeTracerProvider({
});
```

#### AlwaysOff
#### AlwaysOff Sampler

Doesn't sample any trace, regardless of upstream sampling decisions.

Expand All @@ -94,7 +95,7 @@ const tracerProvider = new NodeTracerProvider({
});
```

#### TraceIdRatioBased
#### TraceIdRatioBased Sampler

Samples some percentage of traces, calculated deterministically using the trace ID.
Any trace that would be sampled at a given percentage will also be sampled at any higher percentage.
Expand All @@ -116,7 +117,7 @@ const tracerProvider = new NodeTracerProvider({
});
```

#### ParentBasedSampler
#### ParentBased Sampler

- This is a composite sampler. `ParentBased` helps distinguished between the
following cases:
Expand Down