From 1b771ee8996fd7bf1b596feb9b9f68a737e44446 Mon Sep 17 00:00:00 2001 From: CI-Bot for Emmanuel Courreges Date: Mon, 9 Aug 2021 16:48:21 +0200 Subject: [PATCH] fix: documentation on "Well known exporters" zipkin -> zipkin_json, etc. fix: documentation OTEL_TRACE_EXPORTER -> OTEL_TRACES_EXPORTER --- CHANGELOG.md | 1 + opentelemetry-instrumentation/README.rst | 11 +++++++---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fae7b823869..a4d89e055a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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)) diff --git a/opentelemetry-instrumentation/README.rst b/opentelemetry-instrumentation/README.rst index 18b31f428fa..cae4e3ab5f4 100644 --- a/opentelemetry-instrumentation/README.rst +++ b/opentelemetry-instrumentation/README.rst @@ -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). @@ -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``. @@ -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.