Skip to content

Update documentation of the victorops alertmanager receiver#863

Merged
stuartnelson3 merged 1 commit into
prometheus:masterfrom
PerfectMemory:alerting-configuration-victorops-typos
Oct 11, 2017
Merged

Update documentation of the victorops alertmanager receiver#863
stuartnelson3 merged 1 commit into
prometheus:masterfrom
PerfectMemory:alerting-configuration-victorops-typos

Conversation

@jperville

Copy link
Copy Markdown
Contributor

This PR updates the documentation of the victorops alertmanager receiver, after the discussion in prometheus/alertmanager#1018.

Summary:

@caarlos0 caarlos0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@stuartnelson3 stuartnelson3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Made one comment. I'm not sure how acknowledgement is used, so I don't know if it's necessary or not.

# Describes the behavior of the alert (Critical, Acknowledgement, Info, Recovery).
[ message_type: <string> ]
# Describes the behavior of the alert (CRITICAL, WARNING, INFO, ACKNOWLEDGEMENT or RECOVERY).
[ message_type: <tmpl_string> | default = 'CRITICAL' ]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The default message type when the alert is firing is CRITICAL, if the alert is resolved then it is hardcoded to send RECOVERY.

There's no support for the ACKNOWLEDGEMENT message, as it's not in the white list and will be over-written to CRITICAL when the alert is firing, or be changed to RECOVERY when the alert is resolved.

We should either remove acknowledgement from this list and note that recovery is automatically sent, or add acknowledgement to the whitelist in alertmanager.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure, let's remove ACKNOWLEDGEMENT from the list, since it is not used by alertmanager and there is a whitelist in the code.

@jperville jperville force-pushed the alerting-configuration-victorops-typos branch from 09d7a29 to 6a13c60 Compare October 11, 2017 14:32
@jperville

jperville commented Oct 11, 2017

Copy link
Copy Markdown
Contributor Author

I just updated the PR to remove mention of ACKNOWLEDGEMENT and RECOVERY, since the only values that are whitelisted by the code are CRITICAL, WARNING and INFO (see https://github.com/prometheus/alertmanager/blob/master/notify/impl.go#L845-L849).

@stuartnelson3 stuartnelson3 merged commit 4e0baea into prometheus:master Oct 11, 2017
@jperville jperville deleted the alerting-configuration-victorops-typos branch October 11, 2017 15:34
@jperville

Copy link
Copy Markdown
Contributor Author

Thanks @stuartnelson3

aylei pushed a commit to aylei/docs that referenced this pull request Oct 28, 2019
* op-guide: add precaution when upgrading

Via: pingcap/docs-cn#1033

* op-guide: address the comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants