Skip to content

Commit 836c298

Browse files
Update distributed-tracing.md (#7084)
* Update distributed-tracing.md Issue - #7028 Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Update _observing-your-data/trace/distributed-tracing.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Update _observing-your-data/trace/distributed-tracing.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Update _observing-your-data/trace/distributed-tracing.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Update _observing-your-data/trace/distributed-tracing.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Update _observing-your-data/trace/distributed-tracing.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> --------- Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Co-authored-by: Gagan Juneja <gagandeepjuneja@gmail.com>
1 parent fdf6967 commit 836c298

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

_observing-your-data/trace/distributed-tracing.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,16 @@ testClusters {
124124

125125
### Enable distributed tracing
126126

127-
Once you've enabled the feature flag, you can enable the tracer (which is disabled by default) by using the following dynamic setting that enables tracing in the running cluster:
127+
Once you've enabled the feature flag, do the following:
128+
129+
1. Enable the tracing framework feature by adding the following setting in the `opensearch.yaml` file:
130+
131+
```bash
132+
telemetry.feature.tracer.enabled=true
133+
```
134+
{% include copy.html %}
135+
136+
2. Enable the tracer in the running cluster by adding the following dynamic setting:
128137

129138
```bash
130139
telemetry.tracer.enabled=true
@@ -145,7 +154,7 @@ Currently, the distributed tracing feature generates traces and spans for HTTP r
145154
- `telemetry.otel.tracer.exporter.batch_size`: Configures the maximum batch size for each export to reduce input/output. This value should always be less than the `max_queue_size`. Default is `512`.
146155
2. **Exporters:** Exporters are responsible for persisting the data. OpenTelemetry provides several out-of-the-box exporters, and OpenSearch supports the following:
147156
- `LoggingSpanExporter`: Exports spans to a log file, generating a separate file in the logs directory `_otel_traces.log`. Default is `telemetry.otel.tracer.span.exporter.class=io.opentelemetry.exporter.logging.LoggingSpanExporter`.
148-
- `OtlpGrpcSpanExporter`: Exports spans through gRPC. To use this exporter, you need to install the `otel-collector` on the node. By default, it writes to the http://localhost:4317/ endpoint. To use this exporter, set the following static setting: `telemetry.otel.tracer.span.exporter.class=org.opensearch.telemetry.tracing.exporter.OtlpGrpcSpanExporterProvider`.
157+
- `OtlpGrpcSpanExporter`: Exports spans through gRPC. To use this exporter, you need to install the `otel-collector` on the node. By default, it writes to the http://localhost:4317/ endpoint. To use this exporter, set the following static setting: `telemetry.otel.tracer.span.exporter.class=io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter`.
149158
- `LoggingSpanExporter`: Exports spans to a log file, generating a separate file in the logs directory `_otel_traces.log`. Default is `telemetry.otel.tracer.span.exporter.class=io.opentelemetry.exporter.logging.LoggingSpanExporter`.
150159

151160
### Sampling

0 commit comments

Comments
 (0)