Skip to content

Commit e7421e0

Browse files
committed
Update OTEL_METRICS_EXPORTER envvar documentation
1 parent 36b36a4 commit e7421e0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

opentelemetry-api/src/opentelemetry/environment_variables.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,29 @@
2222
"""
2323
.. envvar:: OTEL_METRICS_EXPORTER
2424
25+
Specifies which exporter is used for metrics. See `General SDK Configuration
26+
<https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_metrics_exporter>`_.
27+
28+
**Default value:** ``"otlp"``
29+
30+
**Example:**
31+
32+
``export OTEL_METRICS_EXPORTER="prometheus"``
33+
34+
Accepted values for ``OTEL_METRICS_EXPORTER`` are:
35+
36+
- ``"otlp"``
37+
- ``"prometheus"``
38+
- ``"none"``: No automatically configured exporter for metrics.
39+
40+
.. note::
41+
42+
Exporter packages may add entry points for group ``opentelemetry_metrics_exporter`` which
43+
can then be used with this environment variable by name. The entry point should point to
44+
either a `opentelemetry.sdk.metrics.export.MetricExporter` (push exporter) or
45+
`opentelemetry.sdk.metrics.export.MetricReader` (pull exporter) subclass; it must be
46+
constructable without any required arguments. This mechanism is considered experimental and
47+
may change in subsequent releases.
2548
"""
2649

2750
OTEL_PROPAGATORS = "OTEL_PROPAGATORS"

0 commit comments

Comments
 (0)