Skip to content

Commit c37fee7

Browse files
authored
[HWORKS-751] add webhook (#395)
1 parent 26bc581 commit c37fee7

File tree

4 files changed

+24
-2
lines changed

4 files changed

+24
-2
lines changed
104 KB
Loading
16.7 KB
Loading
60 KB
Loading

docs/setup_installation/admin/alert.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,38 @@ Then adding the Service key/Routing key of the receiver(s). PagerDuty provides
7070
[documentation](https://www.pagerduty.com/docs/guides/prometheus-integration-guide/) on how to integrate with
7171
Prometheus' Alert manager.
7272

73+
### Step 5: Configure Webhook Alerts
7374

74-
### Step 5: Advanced configuration
75+
You can also use webhooks to send alerts. A Webhook Alert is sent as an HTTP POST command with a JSON-encoded parameter payload.
76+
Click on the _Configure_ button on the left side of the **webhook** row and fill out the form that pops up.
77+
78+
<figure>
79+
<img src="../../../assets/images/alerts/webhook-config.png" alt="Configure Webhook Alerts"/>
80+
<figcaption>Configure Webhook Alerts</figcaption>
81+
</figure>
82+
83+
Fill in the unique URL of your Webhook: the endpoint to send HTTP POST requests to.
84+
85+
A global receiver is created when a webhook is configured and can be used by any project in the cluster.
86+
87+
### Step 6: Advanced configuration
7588
If you are familiar with Prometheus' [Alert manager](https://prometheus.io/docs/alerting/latest/alertmanager/)
76-
you can also configure alerts by editing the _yaml/json_ file directly.
89+
you can also configure alerts by editing the _yaml/json_ file directly by going to the advaced page and clicking the edit button.
90+
91+
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.
92+
93+
The reload button can be used to validate the changes made to the configuration.
94+
It will try to load the new configuration to the alertmanager and show any errors that might prevent the configuration from being loaded.
7795

7896
<figure>
7997
<img src="../../../assets/images/alerts/advanced-config.png" alt="Advanced configuration"/>
8098
<figcaption>Advanced configuration</figcaption>
8199
</figure>
82100

101+
!!!warning
102+
103+
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.
104+
83105
_Example:_ Adding the yaml snippet shown below in the global section of the alert manager configuration will
84106
have the same effect as creating the SMTP configuration as shown in [section 1](#1-email-alerts) above.
85107

0 commit comments

Comments
 (0)