envoyproxy/envoy

Better document and/or improve tracing config precedence

Aperta

#15.050 aperta il 14 feb 2021

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docsarea/tracinghelp wanted

Metriche repository

Star
 (27.997 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Rivedi le tre pagine di documentazione sulla configurazione del tracciamento e proponi aggiornamenti per chiarire la precedenza e aggiungere riferimenti incrociati.
Tech stack
Nessuno
Dominio
networkinginfrastructure
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85