envoyproxy/envoy

Better document and/or improve tracing config precedence

Open

#15.050 aberto em 14 de fev. de 2021

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docsarea/tracinghelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

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?

Guia do colaborador

Direção de pesquisa
Revise as três páginas de documentação de configuração de rastreamento e proponha atualizações para esclarecer a precedência e adicionar referências cruzadas.
Pilha de tecnologia
None
Domain
networkinginfrastructure
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85