opentelemetry-configuration: OTLP HTTP exporter does not validate TLS files exist at startup
Maintainers usually reply within 2 days
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- backend-api-design
Research direction
Read the OTLP HTTP exporter creation paths in _tracer_provider.py, _meter_provider.py, and _logger_provider.py, then compare their TLS handling with the gRPC _read_tls_file() helper. Check how the HTTP exporters receive ca_file, key_file, and cert_file, and look for related configuration tests. Done means unreadable or missing configured TLS files raise ConfigurationError at startup for HTTP exporters.
Written by the indexing model from the issue text.
Description
Describe your environment
- Component:
opentelemetry-configuration - SDK Version:
main(commitaf91f2864c1ce6ee118bbb01e6d6fe7297e05275/ PR #5781) - Python Version: Python 3.10+
- OS: All platforms
What happened?
In PR #5781, TLS and mTLS support was added to declarative configuration for both gRPC and HTTP exporters.
For otlp_grpc, certificate and key file paths are read and validated right away at startup using _read_tls_file(). If a path does not exist or cannot be read, it fails immediately with a clear ConfigurationError:
def _read_tls_file(path: str, field: str) -> bytes:
try:
with open(path, "rb") as file:
return file.read()
except OSError as exc:
raise ConfigurationError(f"Failed to read tls.{field} '{path}': {exc}") from exc
However, for otlp_http exporters (_tracer_provider.py, _meter_provider.py, and _logger_provider.py), the file paths are passed straight to the exporter constructors (OTLPSpanExporter, OTLPMetricExporter, OTLPLogExporter) as raw strings without checking if the files actually exist or can be read.
Why this is a problem in production
- Delayed failures and silent data loss: If a user makes a typo in a certificate path or mounts a Kubernetes secret file with the wrong name or permissions, the service starts up normally without any warning or error. The failure only happens much later when the background worker thread tries to send batches of telemetry over HTTP, causing failed exports and lost data.
- Inconsistent behavior:
otlp_grpcfails fast at startup withConfigurationError, whileotlp_httpsilently ignores missing files until runtime requests fail.
Steps to Reproduce
- Use an
otel-config.yamlwith a missing certificate path:
file_format: "1.0"
tracer_provider:
processors:
- simple:
exporter:
otlp_http:
endpoint: https://collector.example.com:4318/v1/traces
tls:
ca_file: /path/to/missing_ca.pem
- Initialize OpenTelemetry:
from opentelemetry.configuration import load_config_file
load_config_file("otel-config.yaml")
- Startup finishes without any error or validation warning.
- If you change
otlp_httptootlp_grpc, startup immediately fails fast with:
ConfigurationError: Failed to read tls.ca_file '/path/to/missing_ca.pem'
Expected Result
_create_otlp_http_*_exporter should check that configured ca_file, key_file, and cert_file exist and are readable at startup (for example using _read_tls_file or a shared file validation helper), raising ConfigurationError to fail fast just like otlp_grpc.
Would you like to implement a fix?
Yes, happy to help open a pull request.
- Dominant language
- Python
- Stars
- 2.7k
- Forks
- 1.1k
- Avg merge
- 4d 13m
- Merged PRs (30d)
- 38
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from open-telemetry/opentelemetry-python
-
W3CBaggagePropagator drops a list-member over 4096 bytes that W3C Baggage requires it to propagatePossibly taken @codedbyadiiii claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
open-telemetry/opentelemetry-python#5913 ·
Maintainers usually reply within 2 days
-
otel.sdk.processor.{span,log}.queue.capacity uses synchronous UpDownCounter recorded once in __init__May be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
open-telemetry/opentelemetry-python#5891 ·
Maintainers usually reply within 2 days
-
Prometheus map_unit incorrectly normalizes percent ratio units such as %/sPossibly taken @knowprasad claimed this 10 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
open-telemetry/opentelemetry-python#5875 · 1 comment · 1 reaction ·
Maintainers usually reply within 2 days
-
OTLP HTTP exporter reports a 3xx response as a successful export, so redirected batches are dropped without any logPossibly taken @d4rshnn claimed this 18 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
open-telemetry/opentelemetry-python#5865 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 70/100
open-telemetry/opentelemetry-python#5700 · 1 comment ·
Maintainers usually reply within 2 days
All issues in open-telemetry/opentelemetry-python
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docling-project/docling-pipelines#669 ·
Maintainers usually reply within 1 day
-
blocked kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
opendatahub-io/agent-eval-harness#329 · 2 comments · 1 reaction ·
-
cc_wrapper crashes with ValueError on Windows when a path is on another drivePossibly taken @TrapsterDK claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
tweag/rules_haskell#2492 ·
Maintainers usually reply within 1 day