Document --otlp-sample-rate in tracing docs#6798
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix documentation for --otlp-sample-rate flag
Document May 31, 2026
--otlp-sample-rate in tracing docs
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reconciles user-facing tracing documentation with the existing CLI support for configuring OTLP sampling.
Changes:
- Adds
--otlp-sample-rate <float>documentation to the README tracing section, including range and default. - Adds an advanced CONTRIBUTING example showing OTLP endpoint and sample rate usage together.
Show a summary per file
| File | Description |
|---|---|
| README.md | Documents the OTLP sample rate flag alongside tracing configuration guidance. |
| CONTRIBUTING.md | Adds an example command for enabling OTLP tracing with a 25% sample rate. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly docs reconciliation found a minor drift:
--otlp-sample-rateexists in CLI (internal/cmd/tracing.go) but was not discoverable in user-facing docs. This PR reconciles tracing documentation so the sampling control is visible where OTLP configuration is described.README: Tracing flag discoverability
--otlp-sample-rate <float>to the Tracing section alongside existing OTLP env var guidance.0.0–1.0) and default (1.0).CONTRIBUTING: Advanced flag usage