Update documentation of the victorops alertmanager receiver#863
Conversation
stuartnelson3
left a comment
There was a problem hiding this comment.
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' ] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Sure, let's remove ACKNOWLEDGEMENT from the list, since it is not used by alertmanager and there is a whitelist in the code.
09d7a29 to
6a13c60
Compare
|
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). |
|
Thanks @stuartnelson3 |
* op-guide: add precaution when upgrading Via: pingcap/docs-cn#1033 * op-guide: address the comment
This PR updates the documentation of the victorops alertmanager receiver, after the discussion in prometheus/alertmanager#1018.
Summary:
message_typeattribute is a template string (or will be once Allow template in victorops message_type field alertmanager#1038 is merged)state_messageattribute is also template string