From 57114a4916a1d61e6649a4748fcd3ee5de3532f1 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Fri, 23 Feb 2024 17:52:19 +0100 Subject: [PATCH] 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 Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com> Co-authored-by: Jack Baldry --- .../sources/alerting/alerting-rules/_index.md | 52 +++++++-------- ...reate-mimir-loki-managed-recording-rule.md | 16 +++-- .../integrations/_index.md | 50 -------------- .../configure-notifications/_index.md | 26 ++++++++ .../create-notification-policy.md | 3 +- .../create-silence.md | 3 +- .../manage-contact-points/_index.md | 65 +++++++++++++++++++ .../integrations/configure-oncall.md | 4 +- .../integrations/pager-duty.md | 0 .../integrations/webhook-notifier.md | 0 .../mute-timings.md | 3 +- .../template-notifications/_index.md | 16 +++-- .../create-notification-templates.md | 2 + .../images-in-notifications.md | 14 ++-- .../template-notifications/reference.md | 2 + .../use-notification-templates.md | 10 +-- .../using-go-templating-language.md | 14 ++-- .../alerting/manage-notifications/_index.md | 41 +++--------- .../manage-contact-points.md | 34 ---------- docs/sources/alerting/monitor/_index.md | 2 +- .../setup-grafana/configure-grafana/_index.md | 2 +- 21 files changed, 171 insertions(+), 188 deletions(-) delete mode 100644 docs/sources/alerting/alerting-rules/manage-contact-points/integrations/_index.md create mode 100644 docs/sources/alerting/configure-notifications/_index.md rename docs/sources/alerting/{alerting-rules => configure-notifications}/create-notification-policy.md (99%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/create-silence.md (98%) rename docs/sources/alerting/{alerting-rules => configure-notifications}/manage-contact-points/_index.md (51%) rename docs/sources/alerting/{alerting-rules => configure-notifications}/manage-contact-points/integrations/configure-oncall.md (95%) rename docs/sources/alerting/{alerting-rules => configure-notifications}/manage-contact-points/integrations/pager-duty.md (100%) rename docs/sources/alerting/{alerting-rules => configure-notifications}/manage-contact-points/integrations/webhook-notifier.md (100%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/mute-timings.md (98%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/template-notifications/_index.md (78%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/template-notifications/create-notification-templates.md (98%) rename docs/sources/alerting/{manage-notifications => configure-notifications/template-notifications}/images-in-notifications.md (96%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/template-notifications/reference.md (98%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/template-notifications/use-notification-templates.md (72%) rename docs/sources/alerting/{manage-notifications => configure-notifications}/template-notifications/using-go-templating-language.md (93%) delete mode 100644 docs/sources/alerting/manage-notifications/manage-contact-points.md diff --git a/docs/sources/alerting/alerting-rules/_index.md b/docs/sources/alerting/alerting-rules/_index.md index 3063d36929a..1d7c8722d9c 100644 --- a/docs/sources/alerting/alerting-rules/_index.md +++ b/docs/sources/alerting/alerting-rules/_index.md @@ -5,54 +5,46 @@ aliases: - unified-alerting/alerting-rules/ - ./create-alerts/ canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/ -description: Configure the features and integrations you need to create and manage your alerts +description: Create and manage alert rules labels: products: - cloud - enterprise - oss -menuTitle: Configure -title: Configure Alerting +menuTitle: Create and manage alert rules +title: Create and manage alert rules weight: 120 --- -# Configure Alerting +# Create and manage alert rules -Configure the features and integrations that you need to create and manage your alerts. +An alert rule consists of one or more queries and expressions that select the data you want to measure. It also contains a condition, which is the threshold that an alert rule must meet or exceed in order to fire. -**Configure alert rules** +Create, manage, view, and adjust alert rules to alert on your metrics data or log entries from multiple data sources — no matter where your data is stored. -[Configure Grafana-managed alert rules][create-grafana-managed-rule]. +The main parts of alert rule creation are: -[Configure data source-managed alert rules][create-mimir-loki-managed-rule] +1. Select your data source +1. Query your data +1. Normalize your data +1. Set your threshold -**Configure recording rules** +**Query, expressions, and alert condition** -_Recording rules are only available for compatible Prometheus or Loki data sources._ +What are you monitoring? How are you measuring it? -For more information, see [Configure recording rules][create-mimir-loki-managed-recording-rule]. +{{< admonition type="note" >}} +Expressions can only be used for Grafana-managed alert rules. +{{< /admonition >}} -**Configure contact points** +**Evaluation** -For information on how to configure contact points, see [Configure contact points][manage-contact-points]. +How do you want your alert to be evaluated? -**Configure notification policies** +**Labels and notifications** -For information on how to configure notification policies, see [Configure notification policies][create-notification-policy]. +How do you want to route your alert? What kind of additional labels could you add to annotate your alert rules and ease searching? -{{% docs/reference %}} -[create-mimir-loki-managed-rule]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/create-mimir-loki-managed-rule" -[create-mimir-loki-managed-rule]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-mimir-loki-managed-rule" +**Annotations** -[create-mimir-loki-managed-recording-rule]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/create-mimir-loki-managed-recording-rule" -[create-mimir-loki-managed-recording-rule]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-mimir-loki-managed-recording-rule" - -[create-grafana-managed-rule]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/create-grafana-managed-rule" -[create-grafana-managed-rule]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-grafana-managed-rule" - -[manage-contact-points]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/manage-contact-points" -[manage-contact-points]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/manage-contact-points" - -[create-notification-policy]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/create-notification-policy" -[create-notification-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-notification-policy" -{{% /docs/reference %}} +Do you want to add more context on the alert in your notification messages, for example, what caused the alert to fire? Which server did it happen on? diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md index 08fbbbc4929..637cbf3ca48 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md @@ -3,7 +3,7 @@ aliases: - ../unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/ - ../unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/ canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-recording-rule/ -description: Configure recording rules for an external Grafana Mimir or Loki instance +description: Create recording rules for an external Grafana Mimir or Loki instance keywords: - grafana - alerting @@ -16,13 +16,14 @@ labels: - cloud - enterprise - oss -title: Configure recording rules +title: Create recording rules weight: 300 --- -# Configure recording rules +# Create recording rules -You can create and manage recording rules for an external Grafana Mimir or Loki instance. Recording rules calculate frequently needed expressions or computationally expensive expressions in advance and save the result as a new set of time series. Querying this new time series is faster, especially for dashboards since they query the same expression every time the dashboards refresh. +You can create and manage recording rules for an external Grafana Mimir or Loki instance. +Recording rules calculate frequently needed expressions or computationally expensive expressions in advance and save the result as a new set of time series. Querying this new time series is faster, especially for dashboards since they query the same expression every time the dashboards refresh. **Note:** @@ -48,13 +49,14 @@ To create recording rules, follow these steps. 1. Click **Alerts & IRM** -> **Alerting** -> **Alert rules**. -1. Click **New recording rule**. +1. Select **Rule type** -> **Recording**. +1. Click **+New recording rule**. -1. Set rule name. +1. Enter recording rule name. The recording rule name must be a Prometheus metric name and contain no whitespace. -1. Define query. +1. Define recording rule. - Select your Loki or Prometheus data source. - Enter a query. 1. Add namespace and group. diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/_index.md b/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/_index.md deleted file mode 100644 index dfd1efd3c6d..00000000000 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/_index.md +++ /dev/null @@ -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` | diff --git a/docs/sources/alerting/configure-notifications/_index.md b/docs/sources/alerting/configure-notifications/_index.md new file mode 100644 index 00000000000..f709efed8fa --- /dev/null +++ b/docs/sources/alerting/configure-notifications/_index.md @@ -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. diff --git a/docs/sources/alerting/alerting-rules/create-notification-policy.md b/docs/sources/alerting/configure-notifications/create-notification-policy.md similarity index 99% rename from docs/sources/alerting/alerting-rules/create-notification-policy.md rename to docs/sources/alerting/configure-notifications/create-notification-policy.md index 3df48d66ae8..72cfcc9f70a 100644 --- a/docs/sources/alerting/alerting-rules/create-notification-policy.md +++ b/docs/sources/alerting/configure-notifications/create-notification-policy.md @@ -3,6 +3,7 @@ aliases: - ../notifications/ - ../old-alerting/notifications/ - ../unified-alerting/notifications/ + - ./alerting-rules/ canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/create-notification-policy/ description: Configure notification policies to determine how alerts are routed to contact points keywords: @@ -17,7 +18,7 @@ labels: - enterprise - oss title: Configure notification policies -weight: 420 +weight: 430 --- # Configure notification policies diff --git a/docs/sources/alerting/manage-notifications/create-silence.md b/docs/sources/alerting/configure-notifications/create-silence.md similarity index 98% rename from docs/sources/alerting/manage-notifications/create-silence.md rename to docs/sources/alerting/configure-notifications/create-silence.md index 3b0d544360e..9d361832b44 100644 --- a/docs/sources/alerting/manage-notifications/create-silence.md +++ b/docs/sources/alerting/configure-notifications/create-silence.md @@ -6,6 +6,7 @@ aliases: - ../silences/remove-silence/ - ../unified-alerting/silences/ - ../silences/ + - ./alerting/manage-notifications/create-silence/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/ description: Create silences to stop notifications from getting created for a specified window of time keywords: @@ -19,7 +20,7 @@ labels: - enterprise - oss title: Manage silences -weight: 410 +weight: 440 --- # Manage silences diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md b/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md similarity index 51% rename from docs/sources/alerting/alerting-rules/manage-contact-points/_index.md rename to docs/sources/alerting/configure-notifications/manage-contact-points/_index.md index 186c487914b..1f7fa7c184d 100644 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/_index.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md @@ -7,6 +7,10 @@ aliases: - ../contact-points/test-contact-point/ # /docs/grafana//alerting/contact-points/test-contact-point/ - ../manage-notifications/manage-contact-points/ # /docs/grafana//alerting/manage-notifications/manage-contact-points/ - create-contact-point/ # /docs/grafana//alerting/alerting-rules/create-contact-point/ + - ./alerting-rules/ + - ./alerting-rules/manage-notifications/manage-contact-points/ + - alerting/manage-notifications/manage-contact-points/configure-integrations/ + - ./alerting-rules/manage-contact-points/ canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/ description: Configure contact points to define how your contacts are notified when an alert rule fires keywords: @@ -28,6 +32,8 @@ weight: 410 Use contact points to define how your contacts are notified when an alert rule fires. You can add, edit, delete, and test a contact point. +Configure contact point integrations in Grafana to select your preferred communication channel for receiving notifications when your alert rules are firing. + ## Add a contact point Complete the following steps to add a contact point. @@ -75,3 +81,62 @@ Complete the following steps to test a contact point. 1. Click **Test** to open the contact point testing modal. 1. Choose whether to send a predefined test notification or choose custom to add your own custom annotations and labels to include in the notification. 1. Click **Send test notification** to fire the alert. + +## 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 + +## Configure contact point integrations + +Each contact point 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` | +| [Grafana Oncall][oncall] | `oncall` | +| Hipchat | `hipchat` | +| Kafka | `kafka` | +| Line | `line` | +| Microsoft Teams | `teams` | +| Opsgenie | `opsgenie` | +| [Pagerduty][pagerduty] | `pagerduty` | +| Prometheus Alertmanager | `prometheus-alertmanager` | +| Pushover | `pushover` | +| Sensu | `sensu` | +| Sensu Go | `sensugo` | +| Slack | `slack` | +| Telegram | `telegram` | +| Threema | `threema` | +| VictorOps | `victorops` | +| [Webhook][webhook] | `webhook` | + +{{% docs/reference %}} +[pagerduty]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/manage-contact-points/integrations/pager-duty" +[pagerduty]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/pager-duty" + +[oncall]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/manage-contact-points/integrations/configure-oncall" +[oncall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall" + +[webhook]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier" +[webhook]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier" +{{% /docs/reference %}} diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/configure-oncall.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md similarity index 95% rename from docs/sources/alerting/alerting-rules/manage-contact-points/integrations/configure-oncall.md rename to docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md index f71e5053036..bf3fa657a09 100644 --- a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/configure-oncall.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md @@ -63,8 +63,8 @@ To set up the Grafana OnCall integration using the Grafana Alerting application, This redirects you to the Grafana OnCall integration page in the Grafana OnCall application. From there, you can add [routes and escalation chains][escalation-chain]. {{% docs/reference %}} -[create-notification-policy]: "/docs/grafana/ -> /docs/grafana//alerting/alerting-rules/create-notification-policy" -[create-notification-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-notification-policy" +[create-notification-policy]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/create-notification-policy" +[create-notification-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/create-notification-policy" [oncall-integration]: "/docs/grafana/ -> /docs/oncall/latest/integrations/grafana-alerting" [oncall-integration]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/integrations/grafana-alerting" diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/pager-duty.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md similarity index 100% rename from docs/sources/alerting/alerting-rules/manage-contact-points/integrations/pager-duty.md rename to docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md diff --git a/docs/sources/alerting/alerting-rules/manage-contact-points/integrations/webhook-notifier.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md similarity index 100% rename from docs/sources/alerting/alerting-rules/manage-contact-points/integrations/webhook-notifier.md rename to docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md diff --git a/docs/sources/alerting/manage-notifications/mute-timings.md b/docs/sources/alerting/configure-notifications/mute-timings.md similarity index 98% rename from docs/sources/alerting/manage-notifications/mute-timings.md rename to docs/sources/alerting/configure-notifications/mute-timings.md index e3337f7877d..7e6d20154f1 100644 --- a/docs/sources/alerting/manage-notifications/mute-timings.md +++ b/docs/sources/alerting/configure-notifications/mute-timings.md @@ -2,6 +2,7 @@ aliases: - ../notifications/mute-timings/ - ../unified-alerting/notifications/mute-timings/ + - ./alerting/manage-notifications/mute-timings/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/mute-timings/ description: Create mute timings to prevent alerts from firing during a specific and reoccurring period of time keywords: @@ -17,7 +18,7 @@ labels: - enterprise - oss title: Create mute timings -weight: 420 +weight: 450 --- # Create mute timings diff --git a/docs/sources/alerting/manage-notifications/template-notifications/_index.md b/docs/sources/alerting/configure-notifications/template-notifications/_index.md similarity index 78% rename from docs/sources/alerting/manage-notifications/template-notifications/_index.md rename to docs/sources/alerting/configure-notifications/template-notifications/_index.md index 1a5507f577a..00ac7e8ace5 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/_index.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/_index.md @@ -1,4 +1,6 @@ --- +aliases: + - ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/ description: Customize your notifications using notification templates keywords: @@ -12,7 +14,7 @@ labels: - enterprise - oss title: Customize notifications -weight: 400 +weight: 420 --- # Customize notifications @@ -52,12 +54,12 @@ Use notification templates to send notifications to your contact points. Data that is available when writing templates. {{% docs/reference %}} -[reference]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/reference" -[reference]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/reference" +[reference]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/reference" +[reference]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/reference" -[use-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/use-notification-templates" -[use-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/use-notification-templates" +[use-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/use-notification-templates" +[use-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/use-notification-templates" -[using-go-templating-language]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/using-go-templating-language" -[using-go-templating-language]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/using-go-templating-language" +[using-go-templating-language]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/using-go-templating-language" +[using-go-templating-language]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/using-go-templating-language" {{% /docs/reference %}} diff --git a/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md b/docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md similarity index 98% rename from docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md rename to docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md index 947556e4e23..d0b333c14d7 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md @@ -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/ description: Create notification templates to sent to your contact points keywords: diff --git a/docs/sources/alerting/manage-notifications/images-in-notifications.md b/docs/sources/alerting/configure-notifications/template-notifications/images-in-notifications.md similarity index 96% rename from docs/sources/alerting/manage-notifications/images-in-notifications.md rename to docs/sources/alerting/configure-notifications/template-notifications/images-in-notifications.md index 89807f1c8be..ce7806e0870 100644 --- a/docs/sources/alerting/manage-notifications/images-in-notifications.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/images-in-notifications.md @@ -1,4 +1,6 @@ --- +aliases: + - ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/images-in-notifications/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/images-in-notifications/ description: Use images in notifications to help users better understand why alerts are firing or have been resolved keywords: @@ -12,7 +14,7 @@ labels: - enterprise - oss title: Use images in notifications -weight: 405 +weight: 500 --- # Use images in notifications @@ -33,7 +35,7 @@ Refer to the table at the end of this page for a list of contact points and thei ## Requirements -1. To use images in notifications, Grafana must be set up to use [image rendering][image-rendering]. You can either install the image rendering plugin or run it as a remote rendering service. +1. To use images in notifications, Grafana must be set up to use image rendering. You can either install the image rendering plugin or run it as a remote rendering service. 2. When a screenshot is taken it is saved to the [data][paths] folder, even if Grafana is configured to upload screenshots to a cloud storage service. Grafana must have write-access to this folder otherwise screenshots cannot be saved to disk and an error will be logged for each failed screenshot attempt. @@ -69,8 +71,6 @@ If screenshots should be uploaded to cloud storage then `upload_external_image_s # will be persisted to disk for up to temp_data_lifetime. upload_external_image_storage = false -For more information on image rendering, refer to [image rendering][image-rendering]. - Restart Grafana for the changes to take effect. ## Advanced configuration @@ -137,9 +137,3 @@ For example, if a screenshot could not be taken within the expected time (10 sec - `grafana_screenshot_successes_total` - `grafana_screenshot_upload_failures_total` - `grafana_screenshot_upload_successes_total` - -{{% docs/reference %}} -[image-rendering]: "/docs/ -> /docs/grafana//setup-grafana/image-rendering" - -[paths]: "/docs/ -> /docs/grafana//setup-grafana/configure-grafana#paths" -{{% /docs/reference %}} diff --git a/docs/sources/alerting/manage-notifications/template-notifications/reference.md b/docs/sources/alerting/configure-notifications/template-notifications/reference.md similarity index 98% rename from docs/sources/alerting/manage-notifications/template-notifications/reference.md rename to docs/sources/alerting/configure-notifications/template-notifications/reference.md index 16c26acc6d5..dc0dee7f187 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/reference.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/reference.md @@ -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/ description: Learn about templating notifications options keywords: diff --git a/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md b/docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md similarity index 72% rename from docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md rename to docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md index a2a341e02c0..24ae3a2b568 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md @@ -1,4 +1,6 @@ --- +aliases: + - ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/use-notification-templates/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/use-notification-templates/ description: Use notification templates in contact points to customize your notifications keywords: @@ -35,9 +37,9 @@ In the Contact points tab, you can see a list of your contact points. 1. Click **Save contact point**. {{% docs/reference %}} -[create-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/create-notification-templates" -[create-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/create-notification-templates" +[create-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/create-notification-templates" +[create-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/create-notification-templates" -[using-go-templating-language]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/using-go-templating-language" -[using-go-templating-language]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/using-go-templating-language" +[using-go-templating-language]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/using-go-templating-language" +[using-go-templating-language]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/using-go-templating-language" {{% /docs/reference %}} diff --git a/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md b/docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md similarity index 93% rename from docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md rename to docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md index 50115d3f23e..9831bc08b2d 100644 --- a/docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md +++ b/docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md @@ -1,4 +1,6 @@ --- +aliases: + - ./alerting-rules/manage-notifications/manage-contact-points/template-notifications/using-go-templating-language/ canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/template-notifications/using-go-templating-language/ description: Use Go's templating language to create your own notification templates keywords: @@ -280,12 +282,12 @@ grafana_folder = "Test alerts" ``` {{% docs/reference %}} -[create-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/create-notification-templates" -[create-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/create-notification-templates" +[create-notification-templates]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/create-notification-templates" +[create-notification-templates]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/create-notification-templates" -[extendeddata]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/reference#extendeddata" -[extendeddata]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/reference#extendeddata" +[extendeddata]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/reference#extendeddata" +[extendeddata]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/reference#extendeddata" -[reference]: "/docs/grafana/ -> /docs/grafana//alerting/manage-notifications/template-notifications/reference" -[reference]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/template-notifications/reference" +[reference]: "/docs/grafana/ -> /docs/grafana//alerting/configure-notifications/template-notifications/reference" +[reference]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/reference" {{% /docs/reference %}} diff --git a/docs/sources/alerting/manage-notifications/_index.md b/docs/sources/alerting/manage-notifications/_index.md index 1ea9bc24920..5080cb24d26 100644 --- a/docs/sources/alerting/manage-notifications/_index.md +++ b/docs/sources/alerting/manage-notifications/_index.md @@ -1,47 +1,22 @@ --- 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: - grafana - - alert - - notifications + - detect + - respont labels: products: - cloud - enterprise - oss -menuTitle: Manage -title: Manage your alerts +menuTitle: Detect and respond +title: Detect and respond 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] - -[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//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//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//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//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//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 %}} +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. diff --git a/docs/sources/alerting/manage-notifications/manage-contact-points.md b/docs/sources/alerting/manage-notifications/manage-contact-points.md deleted file mode 100644 index bbfd98e4b1e..00000000000 --- a/docs/sources/alerting/manage-notifications/manage-contact-points.md +++ /dev/null @@ -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 diff --git a/docs/sources/alerting/monitor/_index.md b/docs/sources/alerting/monitor/_index.md index 577910d5690..6769d67c94a 100644 --- a/docs/sources/alerting/monitor/_index.md +++ b/docs/sources/alerting/monitor/_index.md @@ -12,7 +12,7 @@ labels: products: - enterprise - oss -menuTitle: Monitor +menuTitle: Monitor alerting title: Meta monitoring weight: 140 --- diff --git a/docs/sources/setup-grafana/configure-grafana/_index.md b/docs/sources/setup-grafana/configure-grafana/_index.md index bf00cb8c985..b89462f9c5b 100644 --- a/docs/sources/setup-grafana/configure-grafana/_index.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -1626,7 +1626,7 @@ The interval string is a possibly signed sequence of decimal numbers, followed b ## [unified_alerting.screenshots] -For more information about screenshots, refer to [Images in notifications]({{< relref "../../alerting/manage-notifications/images-in-notifications" >}}). +For more information about screenshots, refer to [Images in notifications]({{< relref "../../alerting/configure-notifications/template-notifications/images-in-notifications" >}}). ### capture