envoyproxy/envoy

Better document and/or improve tracing config precedence

Open

#15,050 opened on Feb 14, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsarea/tracinghelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 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?

Contributor guide

Research direction
Review the three tracing configuration documentation pages and propose updates to clarify precedence and add cross references.
Tech stack
None
Domain
networkinginfrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85