docs: clarify that time intervals are not inherited by child routes - #5551
docs: clarify that time intervals are not inherited by child routes#5551xenon898 wants to merge 1 commit into
Conversation
The <route> docs state that optional configuration parameters are inherited from the parent node if not set, but mute_time_intervals and active_time_intervals are unconditionally set from the current route's config in newRoute (dispatch/route.go) without the nil-check that the other inherited options use. As a result they are never inherited, and a parent route's time intervals do not mute or gate its subtree. Document the actual behavior so users don't expect a parent's time intervals to apply to child routes. Docs-only, no functional change. Closes prometheus#3211 Signed-off-by: xenon898 <88700568+xenon898@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughThe route configuration documentation now states that ChangesRoute time interval documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Severity of issue fixed: Medium Merge Risk: ⚪ Minimal · up to This change clarifies that route time intervals are not inherited by child routes. It does not alter runtime behavior and is mergeable after normal documentation checks. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
SoloJacobs
left a comment
There was a problem hiding this comment.
#5440 Already meantions this: Please don't close the original issue.
|
Apologies — I did not spot #5440 before opening this. It predates this PR and is more complete (it also lists which parameters are inherited), so closing in its favour. Thanks @SoloJacobs; #3211 stays open for #5440 to resolve. |
What
The
<route>docs say "optional configuration parameters are inherited from its parent node if not set", butmute_time_intervalsandactive_time_intervalsare unconditionally set from the current route's config innewRoute— they lack thenil-check thatgroup_by,group_wait,group_interval, andrepeat_intervaluse, so they are never inherited.This trips users up when they set
mute_time_intervalson a parent route expecting it to mute the whole subtree (see #3211). This PR documents the actual behavior indocs/configuration.md:<route>"inherited from its parent" sentence now notes the exceptionmute_time_intervalsfield comment explains it is not inherited, and how to mute a subtreeactive_time_intervalsfield comment notes it is not inheritedDocs-only, no functional change.
Closes #3211
Follow-up to #3538 (attempted to change the behavior; closed unmerged).
🤖 Generated with Claude Code