0xMiden / 0xMiden/note-transport-service

Docs and CHANGELOG reference telemetry env vars/flags the code doesn't read

Offen Anfängerfreundlich
#134 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation production-readiness
Vorherrschende Sprache
Rust
Sterne
3
Forks
10
Ø Merge
2 Std. 23 Min.
Gemergte PRs (30 T.)
4

Beschreibung

Severity: medium (documentation).

### Summary

Operator docs (`docs/src/operator/monitoring.md:5-7,78-84`, `docs/external/src/operators.md:55-60`) document `OTEL_ENABLED` / `OTEL_TRACES_ENDPOINT`, but the code only reads `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` / `OTEL_EXPORTER_OTLP_ENDPOINT` (`crates/node/src/logging.rs:41-50`). The CHANGELOG (v0.4.1) additionally claims `--enable-otel`/`--otel-endpoint` CLI flags that do not exist (`bin/node/src/main.rs:11-39`).

### Impact

An operator following the published docs gets zero telemetry, silently — compounded by the exporter build error being swallowed at `logging.rs:96` (a malformed endpoint disables tracing with no log).

### Recommendation

Fix both doc trees and the changelog to the actual `OTEL_EXPORTER_OTLP_*` variables; log a warning (or fail startup) when an explicitly-requested OTEL exporter fails to build.

---
Part of #114.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Das Issue verweist auf bestimmte Dateien: docs/src/operator/monitoring.md, docs/external/src/operators.md, crates/node/src/logging.rs und bin/node/src/main.rs. Zuerst sollten die dokumentierten Umgebungsvariablen und CLI-Flags mit dem Code abgeglichen werden. Aktualisieren Sie die Dokumentation, sodass sie den tatsächlichen Variablen (OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT) entspricht, und entfernen Sie Verweise auf nicht existierende Flags. Ziehen Sie außerdem in Betracht, in logging.rs eine Warnmeldung hinzuzufügen, wenn der OTEL-Exporter fehlschlägt. Führen Sie alle vorhandenen Tests im Zusammenhang mit Telemetrie aus, um sicherzustellen, dass die Änderungen keine Funktionalität beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation, observability
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
75/100

Neue Issues direkt in Ihr Postfach

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