0xMiden / 0xMiden/note-transport-service
Docs and CHANGELOG reference telemetry env vars/flags the code doesn't read
- Lingua principale
- Rust
- Stelle
- 3
- Fork
- 10
- Merge medio
- 2h 23m
- PR unite (30g)
- 4
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
L'issue indica file specifici: docs/src/operator/monitoring.md, docs/external/src/operators.md, crates/node/src/logging.rs e bin/node/src/main.rs. Inizia verificando le variabili d'ambiente e i flag CLI documentati rispetto al codice. Aggiorna la documentazione in modo che corrisponda alle variabili effettive (OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT) e rimuovi i riferimenti a flag inesistenti. Considera inoltre di aggiungere un log di avviso in logging.rs quando l'esportatore OTEL fallisce. Esegui eventuali test esistenti relativi alla telemetria per assicurarti che le modifiche non compromettano la funzionalità.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation, observability
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 75/100