Alerting: Improve Alertmanager data source docs (#63611)

Improve Alertmanager data source docs
This commit is contained in:
Konrad Lalik 2023-02-24 13:48:58 +01:00 committed by GitHub
parent b42f973a7a
commit 6e39b7403d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -26,6 +26,27 @@ The data source supports [Prometheus](https://prometheus.io/) and [Grafana Mimir
You can specify the implementation in the data source's Settings page.
When using Prometheus, contact points and notification policies are read-only in the Grafana Alerting UI, because it doesn't support updates to the configuration using HTTP API.
## Configure the data source
**To access the data source configuration page:**
1. Select the **Data sources** section from the **Administration** menu
2. Select the **Alertmanager** data source
Set the data source's basic configuration options carefully:
| Name | Description |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | Sets the name you use to refer to the data source |
| **Default** | Sets whether the data source is pre-selected for new panels and queries |
| **Alertmanager** | |
| **Implementation** | Alertmanager implementation. **Mimir**, **Cortex,** and **Prometheus** are supported |
| **Receive Grafana Alerts** | When enabled the Alertmanager receives alert instances from Grafana-managed alert rules. **Important:** It works only if Grafana alerting is configured to send its alert instances to external Alertmanagers |
| **HTTP** | |
| **URL** | Sets the HTTP protocol, IP, and port of your Alertmanager instance, such as `https://alertmanager.example.org:9093` |
| **Access** | Only **Server** access mode is functional |
| | |
## Provision the Alertmanager data source
You can provision Alertmanager data sources by updating Grafana's configuration files.
@ -42,8 +63,10 @@ datasources:
url: http://localhost:9093
access: proxy
jsonData:
# Options for implementation include prometheus and mimir
# Valid options for implementation include mimir, cortex and prometheus
implementation: prometheus
# Whether or not Grafana should send alert instances to this Alertmanager
handleGrafanaManagedAlerts: false
# optionally
basicAuth: true
basicAuthUser: my_user