Skip to content

docs: add top level tracing configuration key - #5314

Merged
ultrotter merged 1 commit into
prometheus:mainfrom
TheMeier:tracing_doc
Jun 19, 2026
Merged

docs: add top level tracing configuration key#5314
ultrotter merged 1 commit into
prometheus:mainfrom
TheMeier:tracing_doc

Conversation

@TheMeier

Copy link
Copy Markdown
Contributor

Pull Request Checklist

Please check all the applicable boxes.

Which user-facing changes does this PR introduce?

[ENHANCEMENT] DOCS: Add tracing top level key

Signed-off-by: Christoph Maser <christoph.maser+github@gmail.com>
@TheMeier
TheMeier requested a review from a team as a code owner June 19, 2026 07:10
@TheMeier
TheMeier requested a review from siavashs June 19, 2026 07:10
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Two small edits to docs/configuration.md: a new "Optional tracing configuration" subsection is added to the global configuration area, introducing a YAML key traciing: <tracing_config>, and a trailing-whitespace variant is applied to the <http_config> (Shared) section heading line.

Changes

Configuration Documentation

Layer / File(s) Summary
Global tracing config entry and heading whitespace fix
docs/configuration.md
Adds an "Optional tracing configuration" block with the key traciing (typed as <tracing_config>) to the global config section; adjusts whitespace on the <http_config> (Shared) section heading. Note: the key name traciing appears to be a typo for tracing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding top-level tracing configuration key documentation.
Description check ✅ Passed The description follows the template structure with completed checklist items and release notes, indicating all required documentation updates were made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/configuration.md`:
- Around line 178-179: Correct the misspelling in the optional tracing
configuration key in the documentation. Change the typo `traciing` to `tracing`
in the configuration example to match the actual Alertmanager config contract.
This is a simple spelling correction to ensure users copy the correct
configuration key syntax.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: db4d9b7b-aa25-4e55-b16c-0b782884b087

📥 Commits

Reviewing files that changed from the base of the PR and between a3734ba and c436fce.

📒 Files selected for processing (1)
  • docs/configuration.md

Comment thread docs/configuration.md
Comment on lines +178 to +179
# Optional tracing configuration. Configures distributed tracing for Alertmanager.
[ traciing: <tracing_config> ]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix the top-level tracing key spelling.

The docs currently show traciing, but the actual config contract uses tracing. As written, this example will mislead users into copy/pasting an invalid key that Alertmanager will not recognize.

Suggested fix
- [ traciing: <tracing_config> ]
+ [ tracing: <tracing_config> ]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Optional tracing configuration. Configures distributed tracing for Alertmanager.
[ traciing: <tracing_config> ]
# Optional tracing configuration. Configures distributed tracing for Alertmanager.
[ tracing: <tracing_config> ]
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/configuration.md` around lines 178 - 179, Correct the misspelling in the
optional tracing configuration key in the documentation. Change the typo
`traciing` to `tracing` in the configuration example to match the actual
Alertmanager config contract. This is a simple spelling correction to ensure
users copy the correct configuration key syntax.

@ultrotter
ultrotter merged commit df1a9cc into prometheus:main Jun 19, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants