From 53aaf3164bd6b4fc7e58a94c3cba3e15c00e5ce1 Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Tue, 24 Sep 2024 16:42:42 +0200 Subject: [PATCH] observability/apm: reduce python specific doc for OTEL_EXPORTER_OTLP_HEADERS (#4280) * observability/apm: reduce python specific doc for OTEL_EXPORTER_OTLP_HEADERS Special treatment of headers is not needed anymore since latest release so reduce the text to a note. * Looks like callouts do not work in tables * Update docs/en/observability/apm/otel-direct.asciidoc Co-authored-by: Colleen McGinnis --------- Co-authored-by: Colleen McGinnis --- docs/en/observability/apm/otel-direct.asciidoc | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/en/observability/apm/otel-direct.asciidoc b/docs/en/observability/apm/otel-direct.asciidoc index 8f363bec43..df1a47d6f2 100644 --- a/docs/en/observability/apm/otel-direct.asciidoc +++ b/docs/en/observability/apm/otel-direct.asciidoc @@ -126,13 +126,7 @@ For information on how to format an API key, see Please note the required space between `Bearer` and `an_apm_secret_token`, and `ApiKey` and `an_api_key`. -The Python OpenTelemetry agent requires the content of the header to be URL-encoded. For the `Bearer` token that would mean substituting the space between `Bearer` and the token with `%20`, e.g. `"Authorization=Bearer%20an_apm_secret_token"`, for encoding an API key you can use the following snippet: - -[source,python] ----- -from urllib.parse import quote -quote("ApiKey an_api_key") ----- +NOTE: If you are using a version of the Python OpenTelemetry agent _before_ 1.27.0, the content of the header _must_ be URL-encoded. You can use the Python standard library's `urllib.parse.quote` function to encode the content of the header. | `OTEL_METRICS_EXPORTER` | Metrics exporter to use. See https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection[exporter selection] for more information.