Skip to content

Commit 6e89388

Browse files
Update environment variable descriptions to match signal (open-telemetry#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
1 parent 2bcbbcc commit 6e89388

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
([#4176](https://github.com/open-telemetry/opentelemetry-python/pull/4176))
2020
- Update semantic conventions to version 1.28.0
2121
([#4218](https://github.com/open-telemetry/opentelemetry-python/pull/4218))
22+
- Update environment variable descriptions to match signal
23+
([#4222](https://github.com/open-telemetry/opentelemetry-python/pull/4222))
2224

2325
## Version 1.27.0/0.48b0 (2024-08-28)
2426

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -270,29 +270,29 @@
270270
"""
271271
.. envvar:: OTEL_EXPORTER_OTLP_PROTOCOL
272272
273-
The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the the transport protocol for the
273+
The :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` represents the transport protocol for the
274274
OTLP exporter.
275275
"""
276276

277277
OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"
278278
"""
279279
.. envvar:: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
280280
281-
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the the transport protocol for spans.
281+
The :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` represents the transport protocol for spans.
282282
"""
283283

284284
OTEL_EXPORTER_OTLP_METRICS_PROTOCOL = "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL"
285285
"""
286286
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_PROTOCOL
287287
288-
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` represents the the transport protocol for metrics.
288+
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL` represents the transport protocol for metrics.
289289
"""
290290

291291
OTEL_EXPORTER_OTLP_LOGS_PROTOCOL = "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL"
292292
"""
293293
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_PROTOCOL
294294
295-
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` represents the the transport protocol for logs.
295+
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL` represents the transport protocol for logs.
296296
"""
297297

298298
OTEL_EXPORTER_OTLP_CERTIFICATE = "OTEL_EXPORTER_OTLP_CERTIFICATE"
@@ -561,7 +561,7 @@
561561
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_INSECURE
562562
563563
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_INSECURE` represents whether to enable client transport security
564-
for gRPC requests for metrics. A scheme of https takes precedence over the this configuration setting.
564+
for gRPC requests for logs. A scheme of https takes precedence over the this configuration setting.
565565
Default: False
566566
"""
567567

@@ -581,15 +581,15 @@
581581
.. envvar:: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
582582
583583
The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE` stores the path to the certificate file for
584-
TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing.
584+
TLS credentials of gRPC client for metrics. Should only be used for a secure connection for metrics.
585585
"""
586586

587587
OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE = "OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE"
588588
"""
589589
.. envvar:: OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE
590590
591591
The :envvar:`OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE` stores the path to the certificate file for
592-
TLS credentials of gRPC client for traces. Should only be used for a secure connection for tracing.
592+
TLS credentials of gRPC client for logs. Should only be used for a secure connection for logs.
593593
"""
594594

595595
OTEL_EXPORTER_OTLP_METRICS_HEADERS = "OTEL_EXPORTER_OTLP_METRICS_HEADERS"

0 commit comments

Comments
 (0)