Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HWORKS-751] add webhook #395

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/admin/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<figure>
<img src="../../assets/images/alerts/webhook-config.png" alt="Configure Webhook Alerts"/>
<figcaption>Configure Webhook Alerts</figcaption>
</figure>

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.

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

!!!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.

Expand Down
Binary file modified docs/assets/images/alerts/advanced-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/alerts/configure-alerts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/alerts/webhook-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.