mirror of https://github.com/grafana/grafana
Alerting docs: rework create alert rules definition and topic (#83220)
* Alerting docs: rework create alert rules definition and topic * ran prettier * corrects note * adds configure notifications section * update branch * corrects links * parts of alert rule creation * Update docs/sources/alerting/configure-notifications/_index.md Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com> * moved section * updates recording rule steps * gets rid of configure integrations topic * deletes configure integrations topic * deletes links * ran prettier * Include contact point links * phase 2 sorting out manage notifications * manage notification changes * manage notification updates * finishing touches * fixes links * link fixes * more link fix * link fixes * ran prettier --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>pull/83328/head
brendamuir
1 year ago
committed by
GitHub
parent
1477e658ec
commit
57114a4916
@ -1,50 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- alerting/manage-notifications/manage-contact-points/configure-integrations/ |
|
||||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/integrations/ |
|
||||||
description: Configure contact point integrations to select your preferred communication channels for receiving notifications of firing alerts. |
|
||||||
keywords: |
|
||||||
- Grafana |
|
||||||
- alerting |
|
||||||
- guide |
|
||||||
- notifications |
|
||||||
- integrations |
|
||||||
- contact points |
|
||||||
labels: |
|
||||||
products: |
|
||||||
- cloud |
|
||||||
- enterprise |
|
||||||
- oss |
|
||||||
title: Configure contact point integrations |
|
||||||
weight: 100 |
|
||||||
--- |
|
||||||
|
|
||||||
# Configure contact point integrations |
|
||||||
|
|
||||||
Configure contact point integrations in Grafana to select your preferred communication channel for receiving notifications when your alert rules are firing. Each integration has its own configuration options and setup process. In most cases, this involves providing an API key or a Webhook URL. |
|
||||||
|
|
||||||
Once configured, you can use integrations as part of your contact points to receive notifications whenever your alert changes its state. In this section, we'll cover the basic steps to configure your integrations, so you can start receiving real-time alerts and stay on top of your monitoring data. |
|
||||||
|
|
||||||
## List of supported integrations |
|
||||||
|
|
||||||
| Name | Type | |
|
||||||
| ----------------------- | ------------------------- | |
|
||||||
| DingDing | `dingding` | |
|
||||||
| Discord | `discord` | |
|
||||||
| Email | `email` | |
|
||||||
| Google Chat | `googlechat` | |
|
||||||
| Hipchat | `hipchat` | |
|
||||||
| Kafka | `kafka` | |
|
||||||
| Line | `line` | |
|
||||||
| Microsoft Teams | `teams` | |
|
||||||
| Opsgenie | `opsgenie` | |
|
||||||
| Pagerduty | `pagerduty` | |
|
||||||
| Prometheus Alertmanager | `prometheus-alertmanager` | |
|
||||||
| Pushover | `pushover` | |
|
||||||
| Sensu | `sensu` | |
|
||||||
| Sensu Go | `sensugo` | |
|
||||||
| Slack | `slack` | |
|
||||||
| Telegram | `telegram` | |
|
||||||
| Threema | `threema` | |
|
||||||
| VictorOps | `victorops` | |
|
||||||
| Webhook | `webhook` | |
|
||||||
@ -0,0 +1,26 @@ |
|||||||
|
--- |
||||||
|
canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications |
||||||
|
description: Configure how, when, and where to send your alert notifications |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- alert |
||||||
|
- notifications |
||||||
|
labels: |
||||||
|
products: |
||||||
|
- cloud |
||||||
|
- enterprise |
||||||
|
- oss |
||||||
|
menuTitle: Configure notifications |
||||||
|
title: Configure notifications |
||||||
|
weight: 125 |
||||||
|
--- |
||||||
|
|
||||||
|
# Configure notifications |
||||||
|
|
||||||
|
Choose how, when, and where to send your alert notifications. |
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
Optionally, you can add notification templates to contact points for reuse and consistent messaging in your notifications. |
||||||
@ -1,4 +1,6 @@ |
|||||||
--- |
--- |
||||||
|
aliases: |
||||||
|
- ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/create-notification-templates/ |
||||||
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/create-notification-templates/ |
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/create-notification-templates/ |
||||||
description: Create notification templates to sent to your contact points |
description: Create notification templates to sent to your contact points |
||||||
keywords: |
keywords: |
||||||
@ -1,4 +1,6 @@ |
|||||||
--- |
--- |
||||||
|
aliases: |
||||||
|
- ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/reference/ |
||||||
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/reference/ |
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/reference/ |
||||||
description: Learn about templating notifications options |
description: Learn about templating notifications options |
||||||
keywords: |
keywords: |
||||||
@ -1,47 +1,22 @@ |
|||||||
--- |
--- |
||||||
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/ |
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/ |
||||||
description: Manage your alerts by creating silences, mute timings, and more |
description: Detect and respond for day-to-day triage and analysis of what’s going on and action you need to take |
||||||
keywords: |
keywords: |
||||||
- grafana |
- grafana |
||||||
- alert |
- detect |
||||||
- notifications |
- respont |
||||||
labels: |
labels: |
||||||
products: |
products: |
||||||
- cloud |
- cloud |
||||||
- enterprise |
- enterprise |
||||||
- oss |
- oss |
||||||
menuTitle: Manage |
menuTitle: Detect and respond |
||||||
title: Manage your alerts |
title: Detect and respond |
||||||
weight: 130 |
weight: 130 |
||||||
--- |
--- |
||||||
|
|
||||||
# Manage your alerts |
# Detect and respond |
||||||
|
|
||||||
Once you have set up your alert rules, contact points, and notification policies, you can use Grafana Alerting to: |
Use Grafana Alerting to track and generate alerts and send notifications, providing an efficient way for engineers to monitor, respond, and triage issues within their services. |
||||||
|
|
||||||
[Create silences][create-silence] |
Alerts and alert notifications provide a lot of value as key indicators to issues during the triage process, providing engineers with the information they need to understand what is going on in their system or service. |
||||||
|
|
||||||
[Create mute timings][mute-timings] |
|
||||||
|
|
||||||
[Declare incidents from firing alerts][declare-incident-from-firing-alert] |
|
||||||
|
|
||||||
[View the state and health of alert rules][view-state-health] |
|
||||||
|
|
||||||
[View and filter alert rules][view-alert-rules] |
|
||||||
|
|
||||||
{{% docs/reference %}} |
|
||||||
[create-silence]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/create-silence" |
|
||||||
[create-silence]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/create-silence" |
|
||||||
|
|
||||||
[declare-incident-from-firing-alert]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/declare-incident-from-alert" |
|
||||||
[declare-incident-from-firing-alert]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/declare-incident-from-alert" |
|
||||||
|
|
||||||
[mute-timings]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/mute-timings" |
|
||||||
[mute-timings]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/mute-timings" |
|
||||||
|
|
||||||
[view-alert-rules]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/view-alert-rules" |
|
||||||
[view-alert-rules]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/view-alert-rules" |
|
||||||
|
|
||||||
[view-state-health]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/view-state-health" |
|
||||||
[view-state-health]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/view-state-health" |
|
||||||
{{% /docs/reference %}} |
|
||||||
|
|||||||
@ -1,34 +0,0 @@ |
|||||||
--- |
|
||||||
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/manage-contact-points/ |
|
||||||
description: View, edit, copy, or delete your contact points and notification templates |
|
||||||
keywords: |
|
||||||
- grafana |
|
||||||
- alerting |
|
||||||
- contact points |
|
||||||
- search |
|
||||||
- export |
|
||||||
labels: |
|
||||||
products: |
|
||||||
- cloud |
|
||||||
- enterprise |
|
||||||
- oss |
|
||||||
title: Manage contact points |
|
||||||
weight: 410 |
|
||||||
--- |
|
||||||
|
|
||||||
# Manage contact points |
|
||||||
|
|
||||||
The Contact points list view lists all existing contact points and notification templates. |
|
||||||
|
|
||||||
On the **Contact Points** tab, you can: |
|
||||||
|
|
||||||
- Search for name and type of contact points and integrations |
|
||||||
- View all existing contact points and integrations |
|
||||||
- View how many notification policies each contact point is being used for and navigate directly to the linked notification policies |
|
||||||
- View the status of notification deliveries |
|
||||||
- Export individual contact points or all contact points in JSON, YAML, or Terraform format |
|
||||||
- Delete contact points that are not in use by a notification policy |
|
||||||
|
|
||||||
On the **Notification templates** tab, you can: |
|
||||||
|
|
||||||
- View, edit, copy or delete existing notification templates |
|
||||||
Loading…
Reference in new issue