docs: note mute/active time intervals are not inherited - #5440
Conversation
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>
📝 WalkthroughWalkthroughThe route configuration documentation now states that ChangesRoute interval documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Description checkExplanation The description accurately explains the documentation change, but it omits the required checklist, documentation checkbox, sign-off confirmation, best-practices confirmation, and release-notes section content. Resolution Complete the repository template. Include the applicable checklist selections, confirm required documentation and commit sign-off, state whether the change affects user-facing behavior, and fill the release-notes block with NONE or an appropriate entry. ✨ 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 |
| A route block defines a node in a routing tree and its children. Most optional | ||
| configuration parameters are inherited from its parent node if not set | ||
| (`receiver`, `group_by`, `group_wait`, `group_interval`, `repeat_interval`, and | ||
| `labels`). |
There was a problem hiding this comment.
labels behave differently.
| (`receiver`, `group_by`, `group_wait`, `group_interval`, `repeat_interval`, and | ||
| `labels`). | ||
|
|
||
| **Exception:** `mute_time_intervals` and `active_time_intervals` are **not** |
There was a problem hiding this comment.
I think a simple sentence with the explanation is fine here. Also, the general idea this sentence is given is wrong: We don't have merging on any lists such as group_by either. The way these parameters really differ is that if they are omitted: In those cases one gets [] rather than what the parent specified.
(This matches the current implementation: those fields are
always taken from the route itself, defaulting to empty.)
Please don't leak the what you are doing in the task inside of our docs.
| @@ -330,6 +338,9 @@ labels: | |||
| # When a route is muted it will not send any notifications, but | |||
| # otherwise acts normally (including ending the route-matching process | |||
| # if the `continue` option is not set.) | |||
| # | |||
| # Not inherited from parent routes. Omit this field only if the route | |||
There was a problem hiding this comment.
I think there is better formulation, just by saying what happens if the field is omitted.
|
Could you please also remove the |
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.