From 6e893887fd549b8a87ab754c7fe97bd3cdc60143 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> Date: Mon, 14 Oct 2024 08:19:53 -0700 Subject: [PATCH] Update environment variable descriptions to match signal (#4222) * chore: Update envvar descriptions to match signal In some cases, a signal different from the one the environment variable was named after was used in the documentation. * chore: Add changelog entry for envvar desc updates * Remove duplicate "the"s --- CHANGELOG.md | 2 ++ .../sdk/environment_variables/__init__.py | 14 +++++++------- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6699a625537..e4ea8a8bf1a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#4176](https://github.com/open-telemetry/opentelemetry-python/pull/4176)) - Update semantic conventions to version 1.28.0 ([#4218](https://github.com/open-telemetry/opentelemetry-python/pull/4218)) +- Update environment variable descriptions to match signal + ([#4222](https://github.com/open-telemetry/opentelemetry-python/pull/4222)) ## Version 1.27.0/0.48b0 (2024-08-28) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py index bda4cb60581..5fd4cd94eea 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py @@ -270,7 +270,7 @@ """ .. envvar:: OTEL_EXPORTER_OTLP_PROTOCOL -The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the the transport protocol for the +The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the transport protocol for the OTLP exporter. """ @@ -278,21 +278,21 @@ """ .. envvar:: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL -The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the the transport protocol for spans. +The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the transport protocol for spans. """ OTEL_EXPORTER_OTLP_METRICS_PROTOCOL = "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL" """ .. envvar:: OTEL_EXPORTER_OTLP_METRICS_PROTOCOL -The :envvar:`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` represents the the transport protocol for metrics. +The :envvar:`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` represents the transport protocol for metrics. """ OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL" """ .. envvar:: OTEL_EXPORTER_OTLP_LOGS_PROTOCOL -The :envvar:`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` represents the the transport protocol for logs. +The :envvar:`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` represents the transport protocol for logs. """ OTEL_EXPORTER_OTLP_CERTIFICATE = "OTEL_EXPORTER_OTLP_CERTIFICATE" @@ -561,7 +561,7 @@ .. envvar:: OTEL_EXPORTER_OTLP_LOGS_INSECURE The :envvar:`OTEL_EXPORTER_OTLP_LOGS_INSECURE` represents whether to enable client transport security -for gRPC requests for metrics. A scheme of https takes precedence over the this configuration setting. +for gRPC requests for logs. A scheme of https takes precedence over the this configuration setting. Default: False """ @@ -581,7 +581,7 @@ .. envvar:: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` stores the path to the certificate file for -TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing. +TLS credentials of gRPC client for metrics. Should only be used for a secure connection for metrics. """ OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE = "OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE" @@ -589,7 +589,7 @@ .. envvar:: OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE The :envvar:`OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE` stores the path to the certificate file for -TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing. +TLS credentials of gRPC client for logs. Should only be used for a secure connection for logs. """ OTEL_EXPORTER_OTLP_METRICS_HEADERS = "OTEL_EXPORTER_OTLP_METRICS_HEADERS"