这是indexloc提供的服务,不要输入任何密码
Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Conversation

@unlobito
Copy link
Contributor

Please follow the guide below

  • You will be asked some questions, please read them carefully and answer honestly
  • Put an x into all the boxes [ ] relevant to your pull request (like that [x])
  • Use Preview tab to see how your pull request will actually look like

Description

This PR aims to clarify the "Customizing notifications" documentation page with two changes:

  • Fix a typo in Action Notifications (geoupActions should be groupActions)
  • Clarify routing for Unknown Notifications as reusing the existing critNotification path

The 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 warnNotification paths 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.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

I've validated the correct groupActions spelling by referencing cmd/bosun/conf/rule/loaders.go.

I've validated the Unknown Notifications behaviour by creating an alert with a warnNotification path (but without a critNotification path) 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.sh script.

Checklist:

  • This contribution follows the project's code of conduct
  • This contribution follows the project's contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Contributor

@johnewing1 johnewing1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. The behaviour was confusing without this clarification

@johnewing1 johnewing1 merged commit 6313466 into bosun-monitor:master Oct 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants