opentelemetry-configuration: OTLP HTTP exporter does not validate TLS files exist at startup

Offen Anfängerfreundlich
#5,928 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

@Dotify71 arbeitet bereits daran.

Seit 12.11.2026.

  • #5929 von @Dotify71 — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
python

Rechercherichtung

Lies die Erstellungswege der OTLP-HTTP-Exporter in _tracer_provider.py, _meter_provider.py und _logger_provider.py und vergleiche anschließend ihre TLS-Behandlung mit dem gRPC-Helfer _read_tls_file(). Prüfe, wie die HTTP-Exporter ca_file, key_file und cert_file erhalten, und suche nach verwandten Konfigurationstests. Fertig ist die Aufgabe, wenn nicht lesbare oder fehlende konfigurierte TLS-Dateien beim Start für HTTP-Exporter ConfigurationError auslösen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Describe your environment
  • Component: opentelemetry-configuration
  • SDK Version: main (commit af91f2864c1ce6ee118bbb01e6d6fe7297e05275 / 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
  1. 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.
  2. Inconsistent behavior: otlp_grpc fails fast at startup with ConfigurationError, while otlp_http silently ignores missing files until runtime requests fail.
Steps to Reproduce
  1. Use an otel-config.yaml with 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
  1. Initialize OpenTelemetry:
from opentelemetry.configuration import load_config_file

load_config_file("otel-config.yaml")
  1. Startup finishes without any error or validation warning.
  2. If you change otlp_http to otlp_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.

Vorherrschende Sprache
Python
Sterne
2.7k
Forks
1.1k
Ø Merge
4 T. 13 Min.
Gemergte PRs (30 T.)
38

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus open-telemetry/opentelemetry-python

Alle Issues in open-telemetry/opentelemetry-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.