# What this PR does The `docs/reference` shortcode supports contextual destinations and version inference. `<ONCALL VERSION>` is inferred to match the version of the documentation set. For example, the inferred version for the page /docs/grafana/oncall/latest/get-started/ is "latest". It can also be overriden using front matter. Given the same page, but with the additional front matter `oncall_version: next`, the variable is substituted with "next" rather than "latest". Contextual destinations are achieved using repeated labels in the shortcode inner text. The format is [<LABEL>]: "<PAGE PATH PREFIX> -> <HUGO REFERENCE>". - _`<LABEL>`_ matches the reference style link label used in the rest of the text. - _`<PAGE PATH PREFIX>`_ is matched against the page during the production build. If the match is successful, the destination that is used is _`<HUGO REFERENCE>`_. The first matching prefix is used, not the longest matching prefix. ## Which issue(s) this PR fixes - Broken links due to ambiguous relref resolution. Any relref parameter that does not start with either `/`, `./`, or `../` can resolve ambiguously and is resulting in broken link behavior on the current site. - Broken links in Grafana Cloud. We mount OnCall documentation in Grafana Cloud. In https://github.com/grafana/website/pull/13872 the location will become /docs/grafana-cloud/alerting-and-irm/oncall. This PR is intended to be merged alongside that PR. --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
4.8 KiB
| aliases | canonical | keywords | title | weight | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
https://grafana.com/docs/oncall/latest/integrations/available-integrations/configure-alertmanager/ |
|
Alertmanager | 300 |
Alertmanager integration for Grafana OnCall
You must have the [role of Admin][user-and-team-management] to be able to create integrations in Grafana OnCall.
The Alertmanager integration handles alerts from Prometheus Alertmanager. This integration is the recommended way to send alerts from Prometheus deployed in your infrastructure, to Grafana OnCall.
Pro tip: Create one integration per team, and configure alertmanager labels selector to send alerts only related to that team
Configuring Grafana OnCall to Receive Alerts from Prometheus Alertmanager
- In the Integrations tab, click + New integration.
- Select Alertmanager Prometheus from the list of available integrations.
- Enter a name and description for the integration, click Create
- A new page will open with the integration details. Copy the OnCall Integration URL from HTTP Endpoint section. You will need it when configuring Alertmanager.
Configuring Alertmanager to Send Alerts to Grafana OnCall
- Add a new Webhook receiver to
receiverssection of your Alertmanager configuration - Set
urlto the OnCall Integration URL from previous section - Set
send_resolvedtotrue, so Grafana OnCall can autoresolve alert groups when they are resolved in Alertmanager - It is recommended to set
max_alertsto less than300to avoid rate-limiting issues - Use this receiver in your route configuration
Here is the example of final configuration:
route:
receiver: "oncall"
group_by: [alertname, datacenter, app]
receivers:
- name: "oncall"
webhook_configs:
- url: <integation-url>
send_resolved: true
max_alerts: 300
Complete the Integration Configuration
Complete configuration by setting routes, templates, maintenances, etc. Read more in [this section][complete-the-integration-configuration]
Configuring OnCall Heartbeats (optional)
An OnCall heartbeat acts as a monitoring for monitoring systems. If your monitoring is down and stop sending alerts, Grafana OnCall will notify you about that.
Configuring Grafana OnCall Heartbeat
- Go to Integration Page, click on three dots on top right, click Heartbeat settings
- Copy OnCall Heartbeat URL, you will need it when configuring Alertmanager
- Set up Heartbeat Interval, time period after which Grafana OnCall will start a new alert group if it doesn't receive a heartbeat request
Configuring Alertmanager to send heartbeats to Grafana OnCall Heartbeat
You can configure Alertmanager to regularly send alerts to the heartbeat endpoint. Add vector(1) as a heartbeat
generator to prometheus.yaml. It will always return true and act like always firing alert, which will be sent to
Grafana OnCall once in a given period of time:
groups:
- name: meta
rules:
- alert: heartbeat
expr: vector(1)
labels:
severity: none
annotations:
description: This is a heartbeat alert for Grafana OnCall
summary: Heartbeat for Grafana OnCall
Add receiver configuration to prometheus.yaml with the OnCall Heartbeat URL:
...
route:
...
routes:
- match:
alertname: heartbeat
receiver: 'grafana-oncall-heartbeat'
group_wait: 0s
group_interval: 1m
repeat_interval: 50s
receivers:
- name: 'grafana-oncall-heartbeat'
webhook_configs:
- url: https://oncall-dev-us-central-0.grafana.net/oncall/integrations/v1/alertmanager/1234567890/heartbeat/
send_resolved: false
{{% docs/reference %}} [user-and-team-management]: "/docs/oncall/ -> /docs/oncall//user-and-team-management" [user-and-team-management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/user-and-team-management"
[complete-the-integration-configuration]: "/docs/oncall/ -> /docs/oncall//integrations#complete-the-integration-configuration" [complete-the-integration-configuration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/integrations#complete-the-integration-configuration" {{% /docs/reference %}}