Skip to content

Commit b49f52a

Browse files
committed
add rationale for key OpenTelemetry configuration recommendations
1 parent 42d003f commit b49f52a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

content/en/docs/languages/_includes/exporters/prometheus-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,20 @@ Note:
3333

3434
The OTEL_EXPORTER_OTLP_METRICS_ENDPOINT environment variable is treated as a base URL. The `/v1/metrics` path is appended as defined by the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.50.0/specification/protocol/exporter.md#endpoint-urls-for-otlphttp).
3535

36-
Turn off traces and logs:
36+
Turn off traces and logs when using Prometheus if you only need metrics:
3737

3838
```bash
3939
export OTEL_TRACES_EXPORTER=none
4040
export OTEL_LOGS_EXPORTER=none
4141
```
4242

43-
The default push interval for OpenTelemetry metrics is 60 seconds. The following will set a 15-second push interval:
43+
The default push interval for OpenTelemetry metrics is 60 seconds. The following sets a 15-second interval for more responsive monitoring and faster alerting speed. Shorter intervals may increase network and processing overhead.
4444

4545
```bash
4646
export OTEL_METRIC_EXPORT_INTERVAL=15000
4747
```
4848

49-
If your instrumentation library does not provide `service.name` and `service.instance.id` out-of-the-box, it is highly recommended to set them. The example below assumes that the `uuidgen` command is available on your system.
49+
If your instrumentation library does not provide `service.name` and `service.instance.id` out-of-the-box, it is highly recommended to set them. Without these attributes, it becomes difficult to reliably identify services or distinguish between instances, making debugging and aggregation significantly harder. The example below assumes that the `uuidgen` command is available on your system.
5050

5151
```bash
5252
export OTEL_SERVICE_NAME="my-example-service"

0 commit comments

Comments
 (0)