Skip to content

Commit 8fd1391

Browse files
pokutunavmarchaud
andauthored
docs: fix links & headings about built-in samplers (#2011)
Co-authored-by: Valentin Marchaud <[email protected]>
1 parent 0c7fef7 commit 8fd1391

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

packages/opentelemetry-core/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ This package provides default implementations of the OpenTelemetry API for trace
1616
- [Composite Propagator](#composite-propagator)
1717
- [Baggage Propagator](#baggage-propagator)
1818
- [Built-in Sampler](#built-in-sampler)
19-
- [Always Sampler](#always-sampler)
20-
- [Never Sampler](#never-sampler)
21-
- [Probability Sampler](#probability-sampler)
19+
- [AlwaysOn Sampler](#alwayson-sampler)
20+
- [AlwaysOff Sampler](#alwaysoff-sampler)
21+
- [TraceIdRatioBased Sampler](#traceidratiobased-sampler)
22+
- [ParentBased Sampler](#parentbased-sampler)
2223
- [Useful links](#useful-links)
2324
- [License](#license)
2425

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

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

69-
#### AlwaysOn
70+
#### AlwaysOn Sampler
7071

7172
Samples every trace regardless of upstream sampling decisions.
7273

@@ -81,7 +82,7 @@ const tracerProvider = new NodeTracerProvider({
8182
});
8283
```
8384

84-
#### AlwaysOff
85+
#### AlwaysOff Sampler
8586

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

@@ -94,7 +95,7 @@ const tracerProvider = new NodeTracerProvider({
9495
});
9596
```
9697

97-
#### TraceIdRatioBased
98+
#### TraceIdRatioBased Sampler
9899

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

119-
#### ParentBasedSampler
120+
#### ParentBased Sampler
120121

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

0 commit comments

Comments
 (0)