Skip to content

Commit 13fe291

Browse files
committed
opentelemetry-instrument: Fix documented options
Since the change in `opentelemetry-instrument` to understand environment variables [0], the options documented in this README file are outdated. [0] open-telemetry/opentelemetry-python#1969
1 parent f7256f5 commit 13fe291

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

opentelemetry-instrumentation/README.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ this can be overriden when needed.
5656
The command supports the following configuration options as CLI arguments and environment vars:
5757

5858

59-
* ``--trace-exporter`` or ``OTEL_TRACES_EXPORTER``
59+
* ``--traces_exporter`` or ``OTEL_TRACES_EXPORTER``
6060

6161
Used to specify which trace exporter to use. Can be set to one or more of the well-known exporter
6262
names (see below).
6363

6464
- Defaults to `otlp`.
65-
- Can be set to `none` to disable automatic tracer initialization.
65+
- Can be set to `none` to disable automatic tracer initialization.
6666

67-
You can pass multiple values to configure multiple exporters e.g, ``zipkin,prometheus``
67+
You can pass multiple values to configure multiple exporters e.g, ``zipkin,prometheus``
6868

6969
Well known trace exporter names:
7070

@@ -95,24 +95,24 @@ e.g OTEL_PYTHON_DISABLED_INSTRUMENTATIONS = "requests,django"
9595

9696

9797
Examples
98-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98+
^^^^^^^^
9999

100100
::
101101

102-
opentelemetry-instrument --trace-exporter otlp flask run --port=3000
102+
opentelemetry-instrument --traces_exporter otlp flask run --port=3000
103103

104-
The above command will pass ``--trace-exporter otlp`` to the instrument command and ``--port=3000`` to ``flask run``.
104+
The above command will pass ``--traces_exporter otlp`` to the instrument command and ``--port=3000`` to ``flask run``.
105105

106106
::
107107

108-
opentelemetry-instrument --trace-exporter zipkin_json,otlp celery -A tasks worker --loglevel=info
108+
opentelemetry-instrument --traces_exporter zipkin_json,otlp celery -A tasks worker --loglevel=info
109109

110110
The above command will configure global trace provider, attach zipkin and otlp exporters to it and then
111-
start celery with the rest of the arguments.
111+
start celery with the rest of the arguments.
112112

113113
::
114114

115-
opentelemetry-instrument --ids-generator random flask run --port=3000
115+
opentelemetry-instrument --id_generator random flask run --port=3000
116116

117117
The above command will configure the global trace provider to use the Random IDs Generator, and then
118118
pass ``--port=3000`` to ``flask run``.

0 commit comments

Comments
 (0)