mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: rearrange content order (#70425)
* Docs: rearrange content order * more rearranging * fixes relrefs * fixes links
This commit is contained in:
brendamuir
GitHub
parent
1aac15f383
commit
cd8e5dc140
@ -26,7 +26,7 @@ If the **Continue matching subsequent sibling nodes** option is enabled for a ne
|
||||
|
||||
You can configure Grafana-managed notification policies as well as notification policies for an external Alertmanager data source.
|
||||
|
||||
For more information on notification policies, see [fundamentals of Notification Policies]({{< relref "../fundamentals/notification-policies/index.md" >}}).
|
||||
For more information on notification policies, see [fundamentals of Notification Policies]({{< relref "../fundamentals/notification-policies" >}}).
|
||||
|
||||
## Edit default notification policy
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords:
|
||||
- contact point
|
||||
- templating
|
||||
title: Configure the webhook notifier
|
||||
weight: 1000
|
||||
weight: 200
|
||||
---
|
||||
|
||||
### Configure the webhook notifier
|
||||
@ -45,7 +45,7 @@ Set where, when, and how firing alert instances get routed.
|
||||
|
||||
Each notification policy contains a set of label matchers to indicate which alerts rules or instances it is responsible for. It also has a contact point assigned to it that consists of one or more contact point types, such as Slack or email. Contact points define how your contacts are notified when an alert instance fires.
|
||||
|
||||
For more information on notification policies, see [fundamentals of Notification Policies]({{< relref "../fundamentals/notification-policies/index.md" >}}).
|
||||
For more information on notification policies, see [fundamentals of Notification Policies]({{< relref "../fundamentals/notification-policies" >}}).
|
||||
|
||||
**Message templates**
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords:
|
||||
- rules
|
||||
- create
|
||||
title: Labels and annotations
|
||||
weight: 401
|
||||
weight: 110
|
||||
---
|
||||
|
||||
# Labels and annotations
|
||||
|
||||
@ -12,14 +12,18 @@ keywords:
|
||||
- notification channel
|
||||
- create
|
||||
title: Contact points
|
||||
weight: 410
|
||||
weight: 106
|
||||
---
|
||||
|
||||
# Contact points
|
||||
|
||||
Use contact points to define how your contacts are notified when an alert rule fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert rule fires, a notification is sent to all contact point types listed for a contact point. Contact points can be configured for the Grafana Alertmanager as well as external alertmanagers.
|
||||
Contact points contain the configuration for sending notifications. A contact point is a list of integrations, each of which sends a notification to a particular email address, service or URL. Contact points can have multiple integrations of the same kind, or a combination of integrations of different kinds. For example, a contact point could contain a Pagerduty integration; an email and Slack integration; or a Pagerduty integration, a Slack integration, and two email integrations. You can also configure a contact point with no integrations; in which case no notifications are sent.
|
||||
|
||||
You can also use notification templating to customize notification messages for contact point types.
|
||||
A contact point cannot send notifications until it has been added to a notification policy. A notification policy can only send alerts to one contact point, but a contact point can be added to a number of notification policies at the same time. When an alert matches a notification policy, the alert is sent to the contact point in that notification policy, which then sends a notification to each integration in its configuration.
|
||||
|
||||
Contact points can be configured for the Grafana Alertmanager as well as external alertmanagers.
|
||||
|
||||
You can also use notification templating to customize notification messages for contact point integrations.
|
||||
|
||||
**Note:**
|
||||
|
||||
|
||||
@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Notifications
|
||||
description: Introduction to notifications Policies
|
||||
weight: 107
|
||||
keywords:
|
||||
- grafana
|
||||
- alerting
|
||||
- notification policies
|
||||
---
|
||||
|
||||
# Notifications
|
||||
|
||||
Choosing how, when, and where to send your alert notifications is an important part of setting up your alerting system. These decisions will have a direct impact on your ability to resolve issues quickly and not miss anything important.
|
||||
|
||||
As a first step, define your contact points; where to send your alert notifications to. A contact point is a set of one or more integrations that are used to deliver notifications. Add notification templates to contact points for reuse and consistent messaging in your notifications.
|
||||
|
||||
Next, create a notification policy which is a set of rules for where, when and how your alerts are routed to contact points. In a notification policy, you define where to send your alert notifications by choosing one of the contact points you created.
|
||||
|
||||
## Alertmanagers
|
||||
|
||||
Grafana uses Alertmanagers to send notifications for firing and resolved alerts. Grafana has its own Alertmanager, referred to as "Grafana" in the user interface, but also supports sending notifications from other Alertmanagers too, such as the [Prometheus Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/). The Grafana Alertmanager uses notification policies and contact points to configure how and where a notification is sent; how often a notification should be sent; and whether alerts should all be sent in the same notification, sent in grouped notifications based on a set of labels, or as separate notifications.
|
||||
|
||||
## Notification policies
|
||||
|
||||
Notification policies control when and where notifications are sent. A notification policy can choose to send all alerts together in the same notification, send alerts in grouped notifications based on a set of labels, or send alerts as separate notifications. You can configure each notification policy to control how often notifications should be sent as well as having one or more mute timings to inhibit notifications at certain times of the day and on certain days of the week.
|
||||
|
||||
Notification policies are organized in a tree structure where at the root of the tree there is a notification policy called the default policy. There can be only one default policy and the default policy cannot be deleted.
|
||||
|
||||
Specific routing policies are children of the default policy and can be used to match either all alerts or a subset of alerts based on a set of matching labels. A notification policy matches an alert when its matching labels match the labels in the alert.
|
||||
|
||||
A nested policy can have its own nested policies, which allow for additional matching of alerts. An example of a nested policy could be sending infrastructure alerts to the Ops team; while a nested policy might send high priority alerts to Pagerduty and low priority alerts as emails.
|
||||
|
||||
All alerts, irrespective of their labels, match the default policy. However, when the default policy receives an alert it looks at each nested policy and sends the alert to the first nested policy that matches the alert. If the nested policy has further nested policies, then it can attempt to the match the alert against one of its nested policies. If no nested policies match the alert then the policy itself is the matching policy. If there are no nested policies, or no nested policies match the alert, then the default policy is the matching policy.
|
||||
|
||||
<!-- This definitely needs a diagram and some examples (Gilles) -->
|
||||
|
||||
## Notification templates
|
||||
|
||||
You can customize notifications with templates. For example, templates can be used to change the subject and message of an email, or the title and message of notifications sent to Slack.
|
||||
|
||||
Templates are not limited to an individual integration or contact point, but instead can be used in a number of integrations in the same contact point and even integrations across different contact points. For example, a Grafana user can create a template called `custom_subject_or_title` and use it for both templating subjects in emails and titles of Slack messages without having to create two separate templates.
|
||||
|
||||
All notifications templates are written in [Go's templating language](https://pkg.go.dev/text/template), and are in the Contact points tab on the Alerting page.
|
||||
|
||||
## Silences
|
||||
|
||||
You can use silences to mute notifications from one or more firing rules. Silences do not stop alerts from firing or being resolved, or hide firing alerts in the user interface. A silence lasts as long as its duration which can be configured in minutes, hours, days, months or years.
|
||||
@ -1,14 +1,19 @@
|
||||
---
|
||||
title: Notification Policies
|
||||
description: Introduction to Notification Policies and how they work
|
||||
weight: 409
|
||||
aliases:
|
||||
- ../notifications/
|
||||
description: Notification policies
|
||||
keywords:
|
||||
- grafana
|
||||
- alerting
|
||||
- alertmanager
|
||||
- notification policies
|
||||
- contact points
|
||||
- silences
|
||||
title: Notification policies
|
||||
weight: 410
|
||||
---
|
||||
|
||||
# Notification Policies
|
||||
# Notification policies
|
||||
|
||||
Notification policies provide you with a flexible way of routing alerts to various different receivers. Using label matchers, you can modify alert notification delivery without having to update every individual alert rule.
|
||||
|
||||
@ -1,77 +0,0 @@
|
||||
---
|
||||
aliases:
|
||||
- ../notifications/
|
||||
description: Notifications
|
||||
keywords:
|
||||
- grafana
|
||||
- alerting
|
||||
- alertmanager
|
||||
- notification policies
|
||||
- contact points
|
||||
- silences
|
||||
title: Notifications
|
||||
weight: 410
|
||||
---
|
||||
|
||||
# Notifications
|
||||
|
||||
Grafana uses Alertmanagers to send notifications for firing and resolved alerts. Grafana has its own Alertmanager, referred to as "Grafana" in the user interface, but also supports sending notifications from other Alertmanagers too, such as the [Prometheus Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/). The Grafana Alertmanager uses notification policies and contact points to configure how and where a notification is sent; how often a notification should be sent; and whether alerts should all be sent in the same notification, sent in grouped notifications based on a set of labels, or as separate notifications.
|
||||
|
||||
## Notification policies
|
||||
|
||||
Notification policies control when and where notifications are sent. A notification policy can choose to send all alerts together in the same notification, send alerts in grouped notifications based on a set of labels, or send alerts as separate notifications. You can configure each notification policy to control how often notifications should be sent as well as having one or more mute timings to inhibit notifications at certain times of the day and on certain days of the week.
|
||||
|
||||
Notification policies are organized in a tree structure where at the root of the tree there is a notification policy called the default policy. There can be only one default policy and the default policy cannot be deleted.
|
||||
|
||||
Specific routing policies are children of the default policy and can be used to match either all alerts or a subset of alerts based on a set of matching labels. A notification policy matches an alert when its matching labels match the labels in the alert.
|
||||
|
||||
A nested policy can have its own nested policies, which allow for additional matching of alerts. An example of a nested policy could be sending infrastructure alerts to the Ops team; while a nested policy might send high priority alerts to Pagerduty and low priority alerts as emails.
|
||||
|
||||
All alerts, irrespective of their labels, match the default policy. However, when the default policy receives an alert it looks at each nested policy and sends the alert to the first nested policy that matches the alert. If the nested policy has further nested policies, then it can attempt to the match the alert against one of its nested policies. If no nested policies match the alert then the policy itself is the matching policy. If there are no nested policies, or no nested policies match the alert, then the default policy is the matching policy.
|
||||
|
||||
<!-- This definitely needs a diagram and some examples (Gilles) -->
|
||||
|
||||
## Contact points
|
||||
|
||||
Contact points contain the configuration for sending notifications. A contact point is a list of integrations, each of which sends a notification to a particular email address, service or URL. Contact points can have multiple integrations of the same kind, or a combination of integrations of different kinds. For example, a contact point could contain a Pagerduty integration; an email and Slack integration; or a Pagerduty integration, a Slack integration, and two email integrations. You can also configure a contact point with no integrations; in which case no notifications are sent.
|
||||
|
||||
A contact point cannot send notifications until it has been added to a notification policy. A notification policy can only send alerts to one contact point, but a contact point can be added to a number of notification policies at the same time. When an alert matches a notification policy, the alert is sent to the contact point in that notification policy, which then sends a notification to each integration in its configuration.
|
||||
|
||||
### Supported integrations
|
||||
|
||||
The following table contains the integrations supported in Grafana:
|
||||
|
||||
| Name | Type | Grafana Alertmanager | Other Alertmanagers |
|
||||
| ------------------------------------------------ | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| [DingDing](https://www.dingtalk.com/en) | `dingding` | Supported | N/A |
|
||||
| [Discord](https://discord.com/) | `discord` | Supported | N/A |
|
||||
| Email | `email` | Supported | Supported |
|
||||
| [Google Hangouts](https://hangouts.google.com/) | `googlechat` | Supported | N/A |
|
||||
| [Kafka](https://kafka.apache.org/) | `kafka` | Supported | N/A |
|
||||
| [Line](https://line.me/en/) | `line` | Supported | N/A |
|
||||
| [Microsoft Teams](https://teams.microsoft.com/) | `teams` | Supported | N/A |
|
||||
| [Opsgenie](https://atlassian.com/opsgenie/) | `opsgenie` | Supported | Supported |
|
||||
| [Pagerduty](https://www.pagerduty.com/) | `pagerduty` | Supported | Supported |
|
||||
| [Prometheus Alertmanager](https://prometheus.io) | `prometheus-alertmanager` | Supported | N/A |
|
||||
| [Pushover](https://pushover.net/) | `pushover` | Supported | Supported |
|
||||
| [Sensu Go](https://docs.sensu.io/sensu-go/) | `sensugo` | Supported | N/A |
|
||||
| [Slack](https://slack.com/) | `slack` | Supported | Supported |
|
||||
| [Telegram](https://telegram.org/) | `telegram` | Supported | N/A |
|
||||
| [Threema](https://threema.ch/) | `threema` | Supported | N/A |
|
||||
| [VictorOps](https://help.victorops.com/) | `victorops` | Supported | Supported |
|
||||
| Webhook | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) |
|
||||
| Cisco Webex Teams | `webex` | Supported | Supported |
|
||||
| WeCom | `wecom` | Supported | N/A |
|
||||
| [Zenduty](https://www.zenduty.com/) | `webhook` | Supported | N/A |
|
||||
|
||||
## Templating notifications
|
||||
|
||||
You can customize notifications with templates. For example, templates can be used to change the subject and message of an email, or the title and message of notifications sent to Slack.
|
||||
|
||||
Templates are not limited to an individual integration or contact point, but instead can be used in a number of integrations in the same contact point and even integrations across different contact points. For example, a Grafana user can create a template called `custom_subject_or_title` and use it for both templating subjects in emails and titles of Slack messages without having to create two separate templates.
|
||||
|
||||
All notifications templates are written in [Go's templating language](https://pkg.go.dev/text/template), and are in the Contact points tab on the Alerting page.
|
||||
|
||||
## Silences
|
||||
|
||||
You can use silences to mute notifications from one or more firing rules. Silences do not stop alerts from firing or being resolved, or hide firing alerts in the user interface. A silence lasts as long as its duration which can be configured in minutes, hours, days, months or years.
|
||||
@ -5,11 +5,23 @@ keywords:
|
||||
- grafana
|
||||
- alert
|
||||
- notifications
|
||||
title: Manage your alert notifications
|
||||
title: Manage your alerts
|
||||
weight: 160
|
||||
---
|
||||
|
||||
# Manage your alert notifications
|
||||
# Manage your alerts
|
||||
|
||||
Once you have set up your alert rules, contact points, and notification policies, you can use Grafana Alerting to:
|
||||
|
||||
[Create silences]({{< relref "./create-silence" >}})
|
||||
|
||||
[Create mute timings]({{< relref "./mute-timings" >}})
|
||||
|
||||
[Declare incidents from firing alerts]({{< relref "./declare-incident-from-alert" >}})
|
||||
|
||||
[View the state and health of alert rules]({{< relref "./view-state-health" >}})
|
||||
|
||||
[View and filter alert rules]({{< relref "./view-alert-rules" >}})
|
||||
|
||||
Choosing how, when, and where to send your alert notifications is an important part of setting up your alerting system. These decisions will have a direct impact on your ability to resolve issues quickly and not miss anything important.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ keywords:
|
||||
- silence
|
||||
- mute
|
||||
title: Manage silences
|
||||
weight: 600
|
||||
weight: 410
|
||||
---
|
||||
|
||||
# Manage silences
|
||||
|
||||
@ -6,7 +6,7 @@ keywords:
|
||||
- images
|
||||
- notifications
|
||||
title: Use images in notifications
|
||||
weight: 500
|
||||
weight: 405
|
||||
---
|
||||
|
||||
# Use images in notifications
|
||||
|
||||
@ -11,7 +11,7 @@ keywords:
|
||||
- mute timings
|
||||
- mute time interval
|
||||
title: Create mute timings
|
||||
weight: 700
|
||||
weight: 420
|
||||
---
|
||||
|
||||
# Create mute timings
|
||||
|
||||
@ -18,7 +18,7 @@ Set up or upgrade your implementation of Grafana Alerting.
|
||||
|
||||
These are set-up instructions for Grafana Alerting Open Source.
|
||||
|
||||
To set up Grafana Alerting for Cloud, see ({{< relref "./set-up-cloud/_index.md" >}})
|
||||
To set up Grafana Alerting for Cloud, see ({{< relref "./set-up/set-up-cloud" >}})
|
||||
|
||||
## Before you begin
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ Grafana Cloud Alerting's Prometheus-style alerts are built by querying directly
|
||||
|
||||
These are set up instructions for Grafana Alerting Cloud.
|
||||
|
||||
To set up Grafana Alerting for Open Source, see ({{< relref "../set-up/_index.md" >}})
|
||||
To set up Grafana Alerting for Open Source, see ({{< relref "./set-up" >}})
|
||||
|
||||
To set up Alerting, you need to:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user