diff --git a/docs/admin/alert.md b/docs/admin/alert.md index eaa1e3ab4..a6bd5774c 100644 --- a/docs/admin/alert.md +++ b/docs/admin/alert.md @@ -70,16 +70,38 @@ Then adding the Service key/Routing key of the receiver(s). PagerDuty provides [documentation](https://www.pagerduty.com/docs/guides/prometheus-integration-guide/) on how to integrate with Prometheus' Alert manager. +### Step 5: Configure Webhook Alerts -### Step 5: Advanced configuration +You can also use webhooks to send alerts. A Webhook Alert is sent as an HTTP POST command with a JSON-encoded parameter payload. +Click on the _Configure_ button on the left side of the **webhook** row and fill out the form that pops up. + +
+ Configure Webhook Alerts +
Configure Webhook Alerts
+
+ +Fill in the unique URL of your Webhook: the endpoint to send HTTP POST requests to. + +A global receiver is created when a webhook is configured and can be used by any project in the cluster. + +### Step 6: Advanced configuration If you are familiar with Prometheus' [Alert manager](https://prometheus.io/docs/alerting/latest/alertmanager/) -you can also configure alerts by editing the _yaml/json_ file directly. +you can also configure alerts by editing the _yaml/json_ file directly by going to the advaced page and clicking the edit button. + +The advanced page shows the configuration currently loaded on the alert manager. After editing the configuration it takes some time to propagate changes to the alertmanager. + +The reload button can be used to validate the changes made to the configuration. +It will try to load the new configuration to the alertmanager and show any errors that might prevent the configuration from being loaded.
Advanced configuration
Advanced configuration
+!!!warning + + If you make any changes to the configuration ensure that the changes are valid by reloading the configuration until the changes are loaded and visible in the advanced page. + _Example:_ Adding the yaml snippet shown below in the global section of the alert manager configuration will have the same effect as creating the SMTP configuration as shown in [section 1](#1-email-alerts) above. diff --git a/docs/assets/images/alerts/advanced-config.png b/docs/assets/images/alerts/advanced-config.png index 8adaa4bdc..5196f809f 100644 Binary files a/docs/assets/images/alerts/advanced-config.png and b/docs/assets/images/alerts/advanced-config.png differ diff --git a/docs/assets/images/alerts/configure-alerts.png b/docs/assets/images/alerts/configure-alerts.png index 8daa1ec60..1d12d7f00 100644 Binary files a/docs/assets/images/alerts/configure-alerts.png and b/docs/assets/images/alerts/configure-alerts.png differ diff --git a/docs/assets/images/alerts/webhook-config.png b/docs/assets/images/alerts/webhook-config.png new file mode 100644 index 000000000..3f8dece98 Binary files /dev/null and b/docs/assets/images/alerts/webhook-config.png differ