Skip to content

Commit 175658c

Browse files
authored
Merge pull request #39867 from rh-tokeefe/OSSMDOC-375A
OSSMDOC-375A: Distinguish between the Envoy and Jaeger sampling.
2 parents b019e12 + 8de439b commit 175658c

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

modules/ossm-config-sampling.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,23 @@
55
[id="ossm-config-sampling_{context}"]
66
= Adjusting the sampling rate
77

8-
The distributed tracing sampling rate is set to sample 100% of traces in your service mesh by default. A high sampling rate consumes cluster resources and performance but is useful when debugging issues. Before you deploy {ProductName} in production, set the value to a smaller proportion of traces.
8+
A trace is an execution path between services in the service mesh. A trace is comprised of one or more spans. A span is a logical unit of work that has a name, start time, and duration. The sampling rate determines how often a trace is persisted.
99

10-
A trace is an execution path between services in the service mesh. A trace is comprised of one or more spans. A span is a logical unit of work that has a name, start time, and duration.
10+
The Envoy proxy sampling rate is set to sample 100% of traces in your service mesh by default. A high sampling rate consumes cluster resources and performance but is useful when debugging issues. Before you deploy {ProductName} in production, set the value to a smaller proportion of traces. For example, set `spec.tracing.sampling` to `100` to sample 1% of traces.
1111

12-
The sampling rate determines how often a trace is generated. Configure sampling as a scaled integer representing 0.01% increments.
12+
Configure the Envoy proxy sampling rate as a scaled integer representing 0.01% increments.
1313

1414
In a basic installation, `spec.tracing.sampling` is set to `10000`, which samples 100% of traces. For example:
1515

1616
* Setting the value to 10 samples 0.1% of traces.
1717
* Setting the value to 500 samples 5% of traces.
1818

19-
Setting the value to `10000` is useful for debugging, but can affect performance. For production, set `spec.tracing.sampling` to `100.`
19+
[NOTE]
20+
====
21+
The Envoy proxy sampling rate applies for applications that are available to a Service Mesh, and use the Envoy proxy. This sampling rate determines how much data the Envoy proxy collects and tracks.
22+
23+
The Jaeger remote sampling rate applies to applications that are external to the Service Mesh, and do not use the Envoy proxy, such as a database. This sampling rate determines how much data the distributed tracing system collects and stores. For more information, see xref:../../jaeger/jaeger_install/rhbjaeger-deploying.adoc#jaeger-config-sampling_jaeger-deploying[Configurating Jaeger sampling].
24+
====
2025

2126
.Procedure
2227

0 commit comments

Comments
 (0)