phares3757/gatus
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for the custom alert provider placeholders

Browse Source
This commit is contained in:
TwinProduction 2021-02-18 23:18:14 -05:00
parent b603cdb0ea
commit 0a145da912
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -358,14 +358,15 @@ leveraging Gatus, you could have Gatus call that application endpoint when a ser
would then check if the service that started failing was recently deployed, and if it was, then automatically would then check if the service that started failing was recently deployed, and if it was, then automatically
roll it back. roll it back.
The values `[ALERT_DESCRIPTION]` and `[SERVICE_NAME]` are automatically substituted for the alert description and the The placeholders `[ALERT_DESCRIPTION]` and `[SERVICE_NAME]` are automatically substituted for the alert description and
service name respectively in the body (`alerting.custom.body`) as well as the url (`alerting.custom.url`). the service name. These placeholders can be used in the body (`alerting.custom.body`) and in the url (`alerting.custom.url`).
If you have `send-on-resolved` set to `true`, you may want to use `[ALERT_TRIGGERED_OR_RESOLVED]` to differentiate If you have an alert using the `custom` provider with `send-on-resolved` set to `true`, you can use the
the notifications. It will be replaced for either `TRIGGERED` or `RESOLVED`, based on the situation. `[ALERT_TRIGGERED_OR_RESOLVED]` placeholder to differentiate the notifications.
The aforementioned placeholder will be replaced by `TRIGGERED` or `RESOLVED` accordingly, though it can be modified
(details at the end of this section).
For all intents and purpose, we'll configure the custom alert with a Slack webhook, but you can call anything you want. For all intents and purpose, we'll configure the custom alert with a Slack webhook, but you can call anything you want.
```yaml ```yaml
alerting: alerting:
custom: custom:
@ -393,6 +394,18 @@ services:
- "[RESPONSE_TIME] < 300" - "[RESPONSE_TIME] < 300"
``` ```
Note that you can customize the resolved values for the `[ALERT_TRIGGERED_OR_RESOLVED]` placeholder like so:
```yaml
alerting:
custom:
placeholders:
ALERT_TRIGGERED_OR_RESOLVED:
TRIGGERED: "partial_outage"
RESOLVED: "operational"
```
As a result, the `[ALERT_TRIGGERED_OR_RESOLVED]` in the body of first example of this section would be replaced by
`partial_outage` when an alert is triggered and `operational` when an alert is resolved.
### Kubernetes (ALPHA) ### Kubernetes (ALPHA)
> **WARNING**: This feature is in ALPHA. This means that it is very likely to change in the near future, which means that > **WARNING**: This feature is in ALPHA. This means that it is very likely to change in the near future, which means that