This repository was archived by the owner on Feb 13, 2025. It is now read-only.
docs: Clarify Unknown Notification routing & correct Action Notifications typo #2466
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please follow the guide below
xinto all the boxes [ ] relevant to your pull request (like that [x])Description
This PR aims to clarify the "Customizing notifications" documentation page with two changes:
geoupActionsshould begroupActions)critNotificationpathThe code responsible for routing Unknown Notifications can be found in cmd/bosun/sched/check.go.
This ambiguity in the documentation has personally caused me trouble for alerts which only specify
warnNotificationpaths as these will not receive Unknown Notifications. There's also a ~1.5yr old StackOverflow question covering the same topic, so it seems I'm not the only person to be confused by this behaviour.Big thanks to seanlook for investigating & publishing the reason for this on the StackOverflow question for others to find while the official documentation didn't cover this.
Type of change
From the following, please check the options that are relevant.
How has this been tested?
I've validated the correct
groupActionsspelling by referencing cmd/bosun/conf/rule/loaders.go.I've validated the Unknown Notifications behaviour by creating an alert with a
warnNotificationpath (but without acritNotificationpath) and letting the underlying metric go unknown. Bosun does not create a notification for the now-unknown alert but still reports the alert as unknown from the web UI.I've made sure the Markdown changes still render correctly by using the provided
docs/docker.shscript.Checklist: