mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: recreates setup for oss alerting (#70156)
* recreates setup for oss alerting * fixes relrefs * fix relrefs * fix relref * adds other setup topics * adds other setup topics 2 * adds other setup topics 3 * adds cloud setup * adds cloud setup from legacy * fixes links * removing link * gilles feedback
This commit is contained in:
brendamuir
GitHub
parent
5f4d1d4872
commit
5fc6bf5c69
@ -1,15 +1,61 @@
|
||||
---
|
||||
aliases:
|
||||
- unified-alerting/set-up/
|
||||
description: How to set up additional alerting features and integrations
|
||||
title: Additional setup
|
||||
weight: 600
|
||||
labels:
|
||||
products:
|
||||
- oss
|
||||
description: How to set up alerting features and integrations
|
||||
title: Set up Alerting
|
||||
weight: 107
|
||||
---
|
||||
|
||||
# Additional setup
|
||||
# Set up Alerting
|
||||
|
||||
Alerting supports a plethora of configurations, from [configuring external Alertmanagers]({{< relref "./configure-alertmanager" >}}) to routing Grafana Managed Alerts outside of Grafana, to defining your alerting setup [as-code using Provisioning]({{< relref "./provision-alerting-resources" >}}).
|
||||
Configure the features and integrations that you need to create and manage your alerts.
|
||||
|
||||
Setup Grafana Alerting high-availability mode by [following this guide]({{< relref "./configure-high-availability" >}}).
|
||||
**Note:**
|
||||
|
||||
Connect your alerting setup to Grafana OnCall by [following this guide](/docs/oncall/latest/integrations/available-integrations/add-grafana-alerting/).
|
||||
These are set up instructions for Grafana Alerting Open Source.
|
||||
|
||||
To set up Grafana Alerting for Cloud, see ({{< relref "../set-up-cloud" >}})
|
||||
|
||||
## Before you begin
|
||||
|
||||
- Configure your [data sources]({{< relref "../../administration/data-source-management" >}})
|
||||
- Check which data sources are compatible with and supported by [Grafana Alerting]({{< relref "../fundamentals/data-source-alerting" >}})
|
||||
|
||||
## Set up Alerting
|
||||
|
||||
To set up Alerting, you need to:
|
||||
|
||||
1. Configure alert rules
|
||||
|
||||
- Create Grafana-managed or Mimir/Loki-managed alert rules and recording rules
|
||||
|
||||
1. Configure contact points
|
||||
|
||||
- Check the default contact point and update the email address
|
||||
|
||||
- [Optional] Add new contact points and integrations
|
||||
|
||||
1. Configure notification policies
|
||||
|
||||
- Check the default notification policy
|
||||
|
||||
- [Optional] Add additional nested policies
|
||||
|
||||
- [Optional] Add labels and label matchers to control alert routing
|
||||
|
||||
1. [Optional] Integrate with [Grafana OnCall]
|
||||
(/docs/oncall/latest/integrations/grafana-alerting/)
|
||||
|
||||
## Advanced set-up options
|
||||
|
||||
Grafana Alerting supports many additional configuration options, from configuring external Alertmanagers to routing Grafana-managed alerts outside of Grafana, to defining your alerting setup as code.
|
||||
|
||||
The following topics provide you with advanced configuration options for Grafana Alerting.
|
||||
|
||||
- [Provision alert rules using file provisioning]({{< relref "../set-up/provision-alerting-resources/file-provisioning" >}})
|
||||
- [Provision alert rules using Terraform]({{< relref "../set-up/provision-alerting-resources/terraform-provisioning" >}})
|
||||
- [Add an external Alertmanager]({{< relref "../set-up/configure-alertmanager" >}})
|
||||
- [Configure high availability]({{< relref "../set-up/configure-high-availability" >}})
|
||||
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
- configure
|
||||
- external Alertmanager
|
||||
title: Add an external Alertmanager
|
||||
weight: 100
|
||||
weight: 200
|
||||
---
|
||||
|
||||
# Add an external Alertmanager
|
||||
|
||||
@ -10,7 +10,7 @@ keywords:
|
||||
- ha
|
||||
- high availability
|
||||
title: Enable alerting high availability
|
||||
weight: 300
|
||||
weight: 400
|
||||
---
|
||||
|
||||
# Enable alerting high availability
|
||||
|
||||
@ -8,7 +8,7 @@ keywords:
|
||||
- performance
|
||||
- limitations
|
||||
title: Performance considerations and limitations
|
||||
weight: 450
|
||||
weight: 600
|
||||
---
|
||||
|
||||
# Performance considerations and limitations
|
||||
@ -47,4 +47,4 @@ Grafana cannot be used to receive external alerts. You can only send alerts to t
|
||||
|
||||
You have the option to send Grafana managed alerts to an external Alertmanager, you can find this option in the admin tab on the Alerting page.
|
||||
|
||||
For more information, refer to [this GitHub discussion](https://github.com/grafana/grafana/discussions/45773). For more information on the different Alertmanagers, refer to [Alertmanager]({{< relref "../manage-notifications/alertmanager" >}}).
|
||||
For more information, refer to [this GitHub discussion](https://github.com/grafana/grafana/discussions/45773).
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
- configure
|
||||
- provisioning
|
||||
title: Provision Grafana Alerting resources
|
||||
weight: 200
|
||||
weight: 300
|
||||
---
|
||||
|
||||
# Provision Grafana Alerting resources
|
||||
|
||||
@ -5,14 +5,57 @@ aliases:
|
||||
- /docs/grafana-cloud/legacy-alerting/alerts-rules/
|
||||
- /docs/grafana-cloud/metrics/prometheus/alerts_rules/
|
||||
- /docs/hosted-metrics/prometheus/alerts_rules/
|
||||
description: Prometheus rules with mimirtool
|
||||
title: Prometheus rules with mimirtool
|
||||
- /docs/grafana-cloud/alerts/grafana-cloud-alerting/
|
||||
- /docs/grafana-cloud/how-do-i/grafana-cloud-alerting/
|
||||
- /docs/grafana-cloud/legacy-alerting/grafana-cloud-alerting/
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
description: How to set up Alerting for Cloud
|
||||
title: Set up Alerting for Cloud
|
||||
weight: 100
|
||||
---
|
||||
|
||||
# Prometheus rules with mimirtool
|
||||
# Set up Alerting for Cloud
|
||||
|
||||
This page outlines the steps to use mimirtool and Prometheus-style rules with Grafana Cloud Alerting. You can load Prometheus alerting and recording rules that are evaluated entirely in Grafana Cloud. This allows for global rule evaluation over all of the metrics and logs stored in your Grafana Cloud stack.
|
||||
Configure the features and integrations that you need to create and manage your alerts.
|
||||
|
||||
Grafana Cloud alerts are directly tied to metrics and log data.
|
||||
|
||||
They can be configured either using the UI or by uploading files containing Prometheus and Loki alert rules with mimirtool.
|
||||
|
||||
Grafana Cloud Alerting's Prometheus-style alerts are built by querying directly from the data source itself.
|
||||
|
||||
**Note:**
|
||||
|
||||
These are set up instructions for Grafana Alerting Cloud.
|
||||
|
||||
To set up Grafana Alerting for Open Source, see ({{< relref "../set-up" >}})
|
||||
|
||||
To set up Alerting, you need to:
|
||||
|
||||
1. Configure alert rules
|
||||
|
||||
- Create Mimir/Loki-managed alert rules and recording rules
|
||||
|
||||
2. Configure contact points
|
||||
- Check the default contact point and update the email address
|
||||
- [Optional] Add new contact points and integrations
|
||||
3. Configure notification policies
|
||||
|
||||
- Check the default notification policy
|
||||
- [Optional] Add additional nested policies
|
||||
- [Optional] Add labels and label matchers to control alert routing
|
||||
|
||||
4. [Optional] Integrate with [Grafana OnCall](/docs/oncall/latest/integrations/grafana-alerting/) and [Grafana Incident](/docs/grafana-cloud/incident/set-up/)
|
||||
|
||||
The following topics provide you with advanced configuration options for Grafana Alerting for Cloud.
|
||||
|
||||
## Provision alert rules using mimirtool
|
||||
|
||||
Use `mimirtool` to create and upload alert and recording rules to your Grafana Cloud instance.
|
||||
|
||||
Once created, you can view these alert and recordiing rules from within the Grafana Cloud Alerting page in the UI.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
`mimirtool` does _not_ support Loki.
|
||||
@ -28,29 +71,29 @@ The following sections cover all of these concepts:
|
||||
|
||||
**Note:** You need an API key with proper permissions. You can use the same API key for your Metric, Log, and Alerting instances.
|
||||
|
||||
## Download and install mimirtool
|
||||
### Download and install mimirtool
|
||||
|
||||
mimirtool is a powerful command-line tool for interacting with Mimir, which powers Grafana Cloud Metrics and Alerts. You'll use mimirtool to upload your metric and log rules definition and the Alertmanager configuration using YAML files.
|
||||
`mimirtool` is a powerful command-line tool for interacting with Grafana Mimir, which powers Grafana Cloud Metrics and Alerts. Use `mimirtool` to upload your metric and log rules definition and the Alertmanager configuration using YAML files.
|
||||
|
||||
For more information, including installation instructions, see [Grafana Mimirtool](/docs/mimir/latest/operators-guide/tools/mimirtool).
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
For mimirtool to interact with Grafana Cloud, you must set the correct configuration variables. Set them using either environment variables or a command line flags.
|
||||
For `mimirtool` to interact with Grafana Cloud, you must set the correct configuration variables. Set them using either environment variables or a command line flags.
|
||||
{{% /admonition %}}
|
||||
|
||||
## Upload rules definition to your Grafana Cloud Metrics and Logs instance
|
||||
### Upload rules definition to your Grafana Cloud Metrics and Logs instance
|
||||
|
||||
First, you'll need to upload your alerting and recording rules to your Metrics and Logs instance. You'll need the instance ID and the URL. These should be part of /orgs/`<yourOrgName>`/.
|
||||
|
||||
### Metrics instance
|
||||
**Metrics instance**
|
||||
|
||||
Your Metrics instance is likely to be in the `us-central1` region. Its address would be in the form of [https://prometheus-us-central1.grafana.net](https://prometheus-us-central1.grafana.net).
|
||||
|
||||
### Logs instance
|
||||
**Logs instance**
|
||||
|
||||
Your Logs instance is likely to be in the `us-central1` region. Its address would be in the form of [https://logs-prod-us-central1.grafana.net](https://logs-prod-us-central1.grafana.net).
|
||||
|
||||
### Using mimirtool
|
||||
### Use mimirtool
|
||||
|
||||
With your instance ID, URL, and API key you're now ready to upload your rules to your metrics instance. Use the following commands and files as a reference.
|
||||
|
||||
@ -127,13 +170,13 @@ first_rules:
|
||||
expr: sum by(job) (up)
|
||||
```
|
||||
|
||||
## Upload Alertmanager configuration to your Grafana Cloud Alerts instance
|
||||
## Add an external Alertmanager using mimirtool
|
||||
|
||||
To receive alerts you'll need to upload your Alertmanager configuration to your Grafana Cloud Alerts instance. Similar to the previous step, you'll need the corresponding instance ID, URL and API key. These should be part of /orgs/`<yourOrgName>`/.
|
||||
To receive alerts you need to upload your Alertmanager configuration to your Grafana Cloud Alerts instance. Similar to the previous step, you need the corresponding instance ID, URL and API key. These should be part of /orgs/`<yourOrgName>`/.
|
||||
|
||||
Your Alerts instance is likely to be in the `us-central1` region. Its address would be in the form of [https://alertmanager-us-central1.grafana.net](https://alertmanager-us-central1.grafana.net).
|
||||
|
||||
### Using mimirtool
|
||||
### Use mimirtool
|
||||
|
||||
With your instance ID, URL, and API key you're now ready to upload your Alertmanager configuration to your Alerts instance. Use the following commands and files as a reference.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user