Skip to content

Commit 1b771ee

Browse files
fix: documentation on "Well known exporters" zipkin -> zipkin_json, etc.
fix: documentation OTEL_TRACE_EXPORTER -> OTEL_TRACES_EXPORTER
1 parent e2eb73c commit 1b771ee

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.4.0-0.23b0...HEAD)
8+
- Fix documentation on well known exporters and variable OTEL_TRACES_EXPORTER which were misnamed [#2023](https://github.com/open-telemetry/opentelemetry-python/pull/2023)
89
- `opentelemetry-distro` & `opentelemetry-sdk` Moved Auto Instrumentation Configurator code to SDK
910
to let distros use its default implementation
1011
([#1937](https://github.com/open-telemetry/opentelemetry-python/pull/1937))

opentelemetry-instrumentation/README.rst

+7-4
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ 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_TRACE_EXPORTER``
59+
* ``--trace-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).
@@ -68,11 +68,14 @@ You can pass multiple values to configure multiple exporters e.g, ``zipkin,prome
6868

6969
Well known trace exporter names:
7070

71-
- jaeger
71+
- jaeger_proto
72+
- jaeger_thrift
7273
- opencensus
7374
- otlp
7475
- otlp_proto_grpc_span
75-
- zipkin
76+
- otlp_proto_http_span
77+
- zipkin_json
78+
- zipkin_proto
7679

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

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

103106
::
104107

105-
opentelemetry-instrument --trace-exporter zipkin,otlp celery -A tasks worker --loglevel=info
108+
opentelemetry-instrument --trace-exporter zipkin_json,otlp celery -A tasks worker --loglevel=info
106109

107110
The above command will configure global trace provider, attach zipkin and otlp exporters to it and then
108111
start celery with the rest of the arguments.

0 commit comments

Comments
 (0)