Skip to content

Commit

Permalink
fix: documentation on "Well known exporters" zipkin -> zipkin_json, etc.
Browse files Browse the repository at this point in the history
fix: documentation OTEL_TRACE_EXPORTER -> OTEL_TRACES_EXPORTER
  • Loading branch information
ecourreges-orange committed Aug 10, 2021
1 parent e2eb73c commit 1b771ee
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.4.0-0.23b0...HEAD)
- Fix documentation on well known exporters and variable OTEL_TRACES_EXPORTER which were misnamed [#2023](https://github.com/open-telemetry/opentelemetry-python/pull/2023)
- `opentelemetry-distro` & `opentelemetry-sdk` Moved Auto Instrumentation Configurator code to SDK
to let distros use its default implementation
([#1937](https://github.com/open-telemetry/opentelemetry-python/pull/1937))
Expand Down
11 changes: 7 additions & 4 deletions opentelemetry-instrumentation/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ this can be overriden when needed.
The command supports the following configuration options as CLI arguments and environment vars:


* ``--trace-exporter`` or ``OTEL_TRACE_EXPORTER``
* ``--trace-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).
Expand All @@ -68,11 +68,14 @@ You can pass multiple values to configure multiple exporters e.g, ``zipkin,prome

Well known trace exporter names:

- jaeger
- jaeger_proto
- jaeger_thrift
- opencensus
- otlp
- otlp_proto_grpc_span
- zipkin
- otlp_proto_http_span
- zipkin_json
- zipkin_proto

``otlp`` is an alias for ``otlp_proto_grpc_span``.

Expand Down Expand Up @@ -102,7 +105,7 @@ The above command will pass ``--trace-exporter otlp`` to the instrument command

::

opentelemetry-instrument --trace-exporter zipkin,otlp celery -A tasks worker --loglevel=info
opentelemetry-instrument --trace-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.
Expand Down

0 comments on commit 1b771ee

Please sign in to comment.