0xMiden / 0xMiden/note-transport-service

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

Ouverte Adaptée aux débutants
#134 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
documentation production-readiness
Langage dominant
Rust
Étoiles
3
Forks
10
Merge moyen
2 h 23 min
PR mergées (30 j)
4

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Le problème pointe vers des fichiers spécifiques : docs/src/operator/monitoring.md, docs/external/src/operators.md, crates/node/src/logging.rs et bin/node/src/main.rs. Commencez par vérifier les variables d'environnement et les options CLI documentées par rapport au code. Mettez à jour la documentation pour qu'elle corresponde aux variables réelles (OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT) et supprimez les références aux options inexistantes. Envisagez également d'ajouter un journal d'avertissement dans logging.rs lorsque l'exportateur OTEL échoue. Exécutez tous les tests existants liés à la télémétrie pour vous assurer que les modifications ne cassent pas la fonctionnalité.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation, observability
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
75/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.