Skip to content

docs: note mute/active time intervals are not inherited - #5440

Open
locker95 wants to merge 1 commit into
prometheus:mainfrom
locker95:docs/route-time-interval-no-inherit-3211
Open

docs: note mute/active time intervals are not inherited#5440
locker95 wants to merge 1 commit into
prometheus:mainfrom
locker95:docs/route-time-interval-no-inherit-3211

Conversation

@locker95

@locker95 locker95 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

The route block says optional settings inherit from the parent, but mute_time_intervals / active_time_intervals are always copied from the route itself and default to empty. A parent mute does not apply to children that omit the field.

Documented the exception next to the inheritance sentence and on both fields.

Fixes #3211

Route docs said optional parameters inherit from the parent, but
mute_time_intervals and active_time_intervals are always taken from the
route itself (empty if omitted). Call that out so parents do not look
like they mute children automatically.

Fixes prometheus#3211

Signed-off-by: Dean Chen <862469039@qq.com>
@locker95
locker95 requested a review from a team as a code owner August 7, 2026 20:46
@coderabbitai

coderabbitai Bot commented Aug 7, 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: 97c66910-b81b-483e-8f47-7ca6fd483ed2

📥 Commits

Reviewing files that changed from the base of the PR and between 8d7515a and b728b35.

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

📝 Walkthrough

Walkthrough

The route configuration documentation now states that mute_time_intervals and active_time_intervals are not inherited from parent routes. Each route must define the intervals it uses.

Changes

Route interval documentation

Layer / File(s) Summary
Document route inheritance rules
docs/configuration.md
The route documentation states that mute_time_intervals and active_time_intervals default to empty and must be listed on each route that uses them.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the behavior and links issue #3211, but it omits the repository checklist and release-notes section. Complete the required Pull Request Checklist and add the release-notes block, using NONE if no release note is needed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change for non-inherited mute and active time intervals.
Linked Issues check ✅ Passed The documentation updates directly satisfy issue #3211 by clarifying that both time-interval fields do not inherit from parent routes.
Out of Scope Changes check ✅ Passed The changes are limited to the requested route documentation clarification and contain no unrelated code or scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify lack of route time interval inheritance in docs

2 participants