From 13fe291fe6fb5e73aabc451a17bca8286a9dc1ad Mon Sep 17 00:00:00 2001 From: Michael Manganiello Date: Fri, 15 Oct 2021 15:28:04 -0300 Subject: [PATCH] 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] https://github.com/open-telemetry/opentelemetry-python/pull/1969 --- opentelemetry-instrumentation/README.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/opentelemetry-instrumentation/README.rst b/opentelemetry-instrumentation/README.rst index cae4e3ab5f..6108bb6695 100644 --- a/opentelemetry-instrumentation/README.rst +++ b/opentelemetry-instrumentation/README.rst @@ -56,15 +56,15 @@ this can be overriden when needed. The command supports the following configuration options as CLI arguments and environment vars: -* ``--trace-exporter`` or ``OTEL_TRACES_EXPORTER`` +* ``--traces_exporter`` or ``OTEL_TRACES_EXPORTER`` Used to specify which trace exporter to use. Can be set to one or more of the well-known exporter names (see below). - Defaults to `otlp`. - - Can be set to `none` to disable automatic tracer initialization. + - Can be set to `none` to disable automatic tracer initialization. -You can pass multiple values to configure multiple exporters e.g, ``zipkin,prometheus`` +You can pass multiple values to configure multiple exporters e.g, ``zipkin,prometheus`` Well known trace exporter names: @@ -95,24 +95,24 @@ e.g OTEL_PYTHON_DISABLED_INSTRUMENTATIONS = "requests,django" Examples -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^ :: - opentelemetry-instrument --trace-exporter otlp flask run --port=3000 + opentelemetry-instrument --traces_exporter otlp flask run --port=3000 -The above command will pass ``--trace-exporter otlp`` to the instrument command and ``--port=3000`` to ``flask run``. +The above command will pass ``--traces_exporter otlp`` to the instrument command and ``--port=3000`` to ``flask run``. :: - opentelemetry-instrument --trace-exporter zipkin_json,otlp celery -A tasks worker --loglevel=info + opentelemetry-instrument --traces_exporter zipkin_json,otlp celery -A tasks worker --loglevel=info The above command will configure global trace provider, attach zipkin and otlp exporters to it and then -start celery with the rest of the arguments. +start celery with the rest of the arguments. :: - opentelemetry-instrument --ids-generator random flask run --port=3000 + opentelemetry-instrument --id_generator random flask run --port=3000 The above command will configure the global trace provider to use the Random IDs Generator, and then pass ``--port=3000`` to ``flask run``.