Skip to content

docs: fix traciing typo in tracing config key - #5437

Open
latent-9 wants to merge 1 commit into
prometheus:mainfrom
latent-9:docs/fix-traciing-typo
Open

docs: fix traciing typo in tracing config key#5437
latent-9 wants to merge 1 commit into
prometheus:mainfrom
latent-9:docs/fix-traciing-typo

Conversation

@latent-9

@latent-9 latent-9 commented Aug 2, 2026

Copy link
Copy Markdown

The top-level tracing configuration key in the config reference is misspelled traciing (double i):

# Optional tracing configuration.  Configures distributed tracing for Alertmanager.
[ traciing: <tracing_config> ]

The actual key is tracing — see config/config.go (TracingConfig ... yaml:"tracing,omitempty"), and the surrounding comment and the <tracing_config> type anchor both use tracing. A config copied from the docs currently fails to load with an unknown-field error. Fixed the key to tracing.

Signed-off-by: latent-9 296084221+latent-9@users.noreply.github.com

The top-level tracing configuration key is documented as `traciing`
(double i) in docs/configuration.md; the actual key is `tracing`
(config/config.go, `yaml:"tracing"`), so a config copied from the docs
fails to load with an unknown-field error.

Signed-off-by: latent-9 <296084221+latent-9@users.noreply.github.com>
@latent-9
latent-9 requested a review from a team as a code owner August 2, 2026 04:36
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9cf8e391-fa62-475f-9e23-bd8f8f151dca

📥 Commits

Reviewing files that changed from the base of the PR and between 846bdbf and 4428754.

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

📝 Walkthrough

Walkthrough

The documentation corrects the top-level tracing configuration key from traciing to tracing.

Changes

Tracing documentation

Layer / File(s) Summary
Correct the tracing configuration key
docs/configuration.md
The documented key changes from traciing to tracing.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the typo and its impact, but it omits the required checklist and release-notes section. Use the repository template, complete all applicable checklist items, and add a release-notes block with NONE or an appropriate bugfix entry.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation area and the specific traciing typo fix.
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.
✨ 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.

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