envoyproxy/envoy

Better document and/or improve tracing config precedence

Open

#15.050 geöffnet am 14. Feb. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docsarea/tracinghelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

With the introduction of per-route tracing configuration, the precedence is:

I think the documentation could be structured better.

  1. The Tracing overview section links to the runtime setting, even though it's the coarsest configuration mechanism and doesn't allow for per-route configuration.
  2. The 3 configs documentations (linked above) would do better to link to each other, and the overview documentation would do better to link to all of them.

P.S. re (1) I'm not sure it's even intentional. Perhaps the desired outcome here is that runtime settings, being less specific, should not take precedence over per-route settings?

Contributor Guide

Research-Richtung
Überprüfen Sie die drei Dokumentationsseiten zur Ablaufverfolgungskonfiguration und schlagen Sie Aktualisierungen vor, um die Rangfolge zu verdeutlichen und Querverweise hinzuzufügen.
Tech Stack
Keine
Domain
networkinginfrastructure
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85