mirror of https://github.com/grafana/grafana
Docs: Rewrite alerting docs (#24653)
* updated menu and added alerts-overview.md * Delete metrics.md * Update menu.yaml * changed file name and updated menu * Update create-alerts.md * added file and link * Create view-alerts.md * added content and links * Update pause-an-alert.md * added content and links * edited notification content * updated link * Update docs/sources/alerting/create-alerts.md Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> * Applied marcus e. edits * Update docs/sources/alerting/alerts-overview.md Co-authored-by: Carl Bergquist <carl@grafana.com> Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> Co-authored-by: Carl Bergquist <carl@grafana.com>pull/24704/head
Diana Payton
6 years ago
committed by
GitHub
parent
28344c145f
commit
59ffe4f413
@ -0,0 +1,56 @@ |
||||
+++ |
||||
title = "Alerts overview" |
||||
type = "docs" |
||||
[menu.docs] |
||||
identifier = "alerting" |
||||
parent = "Alerting" |
||||
aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"] |
||||
weight = 100 |
||||
+++ |
||||
|
||||
# Alerts overview |
||||
|
||||
Alerts allow you to identify problems in your system moments after they occur. By quickly identifying unintended changes in your system, you can minimize disruptions to your services. |
||||
|
||||
Alerts consists of two parts: |
||||
|
||||
- Alert rules - When the alert is triggered. Alert rules are defined by one or more conditions that are regularly evaluated by Grafana. |
||||
- Notification channel - How the alert is delivered. When the conditions of an alert rule are met, the Grafana notifies the channels configured for that alert. |
||||
|
||||
Currently only the graph panel visualization supports alerts. |
||||
|
||||
## Alert tasks |
||||
|
||||
You can perform the following tasks for alerts: |
||||
|
||||
- [Add or edit an alert notification channel]({{< relref "notifications.md" >}}) |
||||
- [Create an alert rule]({{< relref "create-alerts.md" >}}) |
||||
- [View existing alert rules and their current state]({{< relref "view-alerts.md" >}}) |
||||
- [Test alert rules and troubleshoot]({{< relref "troubleshoot-alerts.md" >}}) |
||||
|
||||
## Clustering |
||||
|
||||
Currently alerting supports a limited form of high availability. Since v4.2.0 of Grafana, alert notifications are deduped when running multiple servers. This means all alerts are executed on every server but no duplicate alert notifications are sent due to the deduping logic. Proper load balancing of alerts will be introduced in the future. |
||||
|
||||
## Notifications |
||||
|
||||
You can also set alert rule notifications along with a detailed message about the alert rule. The message can contain anything: information about how you might solve the issue, link to runbook, and so on. |
||||
|
||||
The actual notifications are configured and shared between multiple alerts. |
||||
|
||||
## Alert execution |
||||
|
||||
Alert rules are evaluated in the Grafana backend in a scheduler and query execution engine that is part |
||||
of core Grafana. Only some data sources are supported right now. They include `Graphite`, `Prometheus`, `InfluxDB`, `Elasticsearch`, |
||||
`Stackdriver`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Data Explorer`. |
||||
|
||||
## Metrics from the alert engine |
||||
|
||||
The alert engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../administration/metrics/" >}}). |
||||
|
||||
Description | Type | Metric name |
||||
---------- | ----------- | ---------- |
||||
Total number of alerts | counter | `alerting.active_alerts` |
||||
Alert execution result | counter | `alerting.result` |
||||
Notifications sent counter | counter | `alerting.notifications_sent` |
||||
Alert execution timer | timer | `alerting.execution_time` |
||||
@ -0,0 +1,129 @@ |
||||
+++ |
||||
title = "Create alerts" |
||||
description = "Configure alert rules" |
||||
keywords = ["grafana", "alerting", "guide", "rules"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Create alerts" |
||||
parent = "alerting" |
||||
weight = 200 |
||||
+++ |
||||
|
||||
# Create alerts |
||||
|
||||
Grafana alerting allows you to attach rules to your dashboard panels. When you save the dashboard, Grafana extracts the alert rules into a separate alert rule storage and schedules them for evaluation. |
||||
|
||||
{{< imgbox max-width="1000px" img="/img/docs/alerting/drag_handles_gif.gif" caption="Alerting overview" >}} |
||||
|
||||
In the Alert tab of the graph panel you can configure how often the alert rule should be evaluated and the conditions that need to be met for the alert to change state and trigger its [notifications]({{< relref "notifications.md" >}}). |
||||
|
||||
Currently only the graph panel supports alert rules. |
||||
|
||||
## Add or edit an alert rule |
||||
|
||||
1. Navigate to the panel you want to add or edit an alert rule for, click the title, and then click **Edit**. |
||||
1. On the Alert tab, click **Create Alert**. If an alert already exists for this panel, then you can just edit the fields on the Alert tab. |
||||
1. Fill out the fields. Descriptions are listed below in [Alert rule fields](#alert-rule-fields). |
||||
1. When you have finished writing your rule, click **Save** in the upper right corner to save alert rule and the dashboard. |
||||
1. (Optional but recommended) Click **Test rule** to make sure the rule returns the results you expect. |
||||
|
||||
## Delete an alert |
||||
|
||||
To delete an alert, scroll to the bottom of the alert and then click **Delete**. |
||||
|
||||
## Alert rule fields |
||||
|
||||
This section describes the fields you fill out to create an alert. |
||||
|
||||
### Rule |
||||
|
||||
- **Name -** Enter a descriptive name. The name will be displayed in the Alert Rules list. |
||||
- **Evaluate every -** Specify how often the scheduler should evaluate the alert rule. This is referred to as the _evaluation interval_. |
||||
- **For -** Specify how long the query needs to violate the configured thresholds before the alert notification triggers. |
||||
|
||||
You can set a minimum evaluation interval in the `alerting.min_interval_seconds` config field, to set a minimum time between evaluations. Refer to [Configuration]({{< relref "../installation/configuration.md" >}}#min-interval-seconds) for more information. |
||||
|
||||
> **Caution:** Do not use `For` with the `If no data or all values are null` setting set to `No Data`. The triggering of `No Data` will trigger instantly and not take `For` into consideration. This may also result in that an OK notification not being sent if alert transitions from `No Data -> Pending -> OK`. |
||||
|
||||
If an alert rule has a configured `For` and the query violates the configured threshold, then it will first go from `OK` to `Pending`. Going from `OK` to `Pending` Grafana will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. |
||||
|
||||
Typically, it's always a good idea to use this setting since it's often worse to get false positive than wait a few minutes before the alert notification triggers. Looking at the `Alert list` or `Alert list panels` you will be able to see alerts in pending state. |
||||
|
||||
Below you can see an example timeline of an alert using the `For` setting. At ~16:04 the alert state changes to `Pending` and after 4 minutes it changes to `Alerting` which is when alert notifications are sent. Once the series falls back to normal the alert rule goes back to `OK`. |
||||
{{< imgbox img="/img/docs/v54/alerting-for-dark-theme.png" caption="Alerting For" >}} |
||||
|
||||
{{< imgbox max-width="40%" img="/img/docs/v4/alerting_conditions.png" caption="Alerting Conditions" >}} |
||||
|
||||
### Conditions |
||||
|
||||
Currently the only condition type that exists is a `Query` condition that allows you to |
||||
specify a query letter, time range and an aggregation function. |
||||
|
||||
#### Query condition example |
||||
|
||||
```sql |
||||
avg() OF query(A, 15m, now) IS BELOW 14 |
||||
``` |
||||
|
||||
- `avg()` Controls how the values for **each** series should be reduced to a value that can be compared against the threshold. Click on the function to change it to another aggregation function. |
||||
- `query(A, 15m, now)` The letter defines what query to execute from the **Metrics** tab. The second two parameters define the time range, `15m, now` means 15 minutes ago to now. You can also do `10m, now-2m` to define a time range that will be 10 minutes ago to 2 minutes ago. This is useful if you want to ignore the last 2 minutes of data. |
||||
- `IS BELOW 14` Defines the type of threshold and the threshold value. You can click on `IS BELOW` to change the type of threshold. |
||||
|
||||
The query used in an alert rule cannot contain any template variables. Currently we only support `AND` and `OR` operators between conditions and they are executed serially. |
||||
For example, we have 3 conditions in the following order: |
||||
*condition:A(evaluates to: TRUE) OR condition:B(evaluates to: FALSE) AND condition:C(evaluates to: TRUE)* |
||||
so the result will be calculated as ((TRUE OR FALSE) AND TRUE) = TRUE. |
||||
|
||||
We plan to add other condition types in the future, like `Other Alert`, where you can include the state of another alert in your conditions, and `Time Of Day`. |
||||
|
||||
#### Multiple Series |
||||
|
||||
If a query returns multiple series then the aggregation function and threshold check will be evaluated for each series. What Grafana does not do currently is track alert rule state **per series**. This has implications that are detailed in the scenario below. |
||||
|
||||
- Alert condition with query that returns 2 series: **server1** and **server2** |
||||
- **server1** series causes the alert rule to fire and switch to state `Alerting` |
||||
- Notifications are sent out with message: _load peaking (server1)_ |
||||
- In a subsequence evaluation of the same alert rule the **server2** series also cause the alert rule to fire |
||||
- No new notifications are sent as the alert rule is already in state `Alerting`. |
||||
|
||||
So as you can see from the above scenario Grafana will not send out notifications when other series cause the alert to fire if the rule already is in state `Alerting`. To improve support for queries that return multiple series we plan to track state **per series** in a future release. |
||||
|
||||
> Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications |
||||
> when an alert continues to fire. If other series (like server2 in the example above) also cause the alert rule to fire they will be included in the reminder notification. Depending on what notification channel you're using you may be able to take advantage of this feature for identifying new/existing series causing alert to fire. |
||||
|
||||
### No Data & Error Handling |
||||
|
||||
Below are conditions you can configure how the rule evaluation engine should handle queries that return no data or only null values. |
||||
|
||||
No Data Option | Description |
||||
------------ | ------------- |
||||
No Data | Set alert rule state to `NoData` |
||||
Alerting | Set alert rule state to `Alerting` |
||||
Keep Last State | Keep the current alert rule state, what ever it is. |
||||
Ok | Not sure why you would want to send yourself an alert when things are okay, but you could. |
||||
|
||||
### Execution errors or timeouts |
||||
|
||||
Tell Grafana how to handle execution or timeout errors. |
||||
|
||||
Error or timeout option | Description |
||||
------------ | ------------- |
||||
Alerting | Set alert rule state to `Alerting` |
||||
Keep Last State | Keep the current alert rule state, what ever it is. |
||||
|
||||
If you have an unreliable time series store from which queries sometime timeout or fail randomly you can set this option to `Keep Last State` in order to basically ignore them. |
||||
|
||||
## Notifications |
||||
|
||||
In alert tab you can also specify alert rule notifications along with a detailed message about the alert rule. The message can contain anything, information about how you might solve the issue, link to runbook, and so on. |
||||
|
||||
The actual notifications are configured and shared between multiple alerts. Read |
||||
[Alert notifications]({{< relref "notifications.md" >}}) for information on how to configure and set up notifications. |
||||
|
||||
- **Send to -** Select an alert notification channel if you have one set up. |
||||
- **Message -** Enter a message to be sent on the notification channel. The message can be in text, markdown, or HTML format. It can include links and variables as well. |
||||
- **Tags -** Specify a list of tags (key/value) to be included in the notification. It is only supported by [some notifiers]({{< relref "notifications/#all-supported-notifiers" >}}). |
||||
|
||||
## Alert state history and annotations |
||||
|
||||
Alert state changes are recorded in the internal annotation table in Grafana's database. The state changes are visualized as annotations in the alert rule's graph panel. You can also go into the `State history` submenu in the alert tab to view and clear state history. |
||||
@ -1,21 +0,0 @@ |
||||
+++ |
||||
title = "Alerting Metrics" |
||||
description = "Alerting Metrics Guide" |
||||
keywords = ["Grafana", "alerting", "guide", "metrics"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Metrics" |
||||
parent = "alerting" |
||||
weight = 2 |
||||
+++ |
||||
|
||||
# Metrics from the alert engine |
||||
|
||||
The alert engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../administration/metrics/" >}}). |
||||
|
||||
Description | Type | Metric name |
||||
---------- | ----------- | ---------- |
||||
Total number of alerts | counter | `alerting.active_alerts` |
||||
Alert execution result | counter | `alerting.result` |
||||
Notifications sent counter | counter | `alerting.notifications_sent` |
||||
Alert execution timer | timer | `alerting.execution_time` |
||||
@ -0,0 +1,17 @@ |
||||
+++ |
||||
title = "Pause alert rule" |
||||
description = "Pause an existing alert rule" |
||||
keywords = ["grafana", "alerting", "guide", "rules", "view"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
parent = "alerting" |
||||
weight = 400 |
||||
+++ |
||||
|
||||
# Pause an alert rule |
||||
|
||||
Pausing the evaluation of an alert rule can sometimes be useful. For example, during a maintenance window, pausing alert rules can avoid triggering a flood of alerts. |
||||
|
||||
1. In the Grafana side bar, hover your cursor over the Alerting (bell) icon and then click **Alert Rules**. All configured alert rules are listed, along with their current state. |
||||
1. Find your alert in the list, and click the **Pause** icon on the right. The **Pause** icon turns into a **Play** icon. |
||||
1. Click the **Play** icon to resume evaluation of your alert. |
||||
@ -1,174 +0,0 @@ |
||||
+++ |
||||
title = "Alerting Engine and Rules Guide" |
||||
description = "Configuring Alert Rules" |
||||
keywords = ["grafana", "alerting", "guide", "rules"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Engine and Rules" |
||||
parent = "alerting" |
||||
weight = 1 |
||||
+++ |
||||
|
||||
# Alerting Engine and Rules Guide |
||||
|
||||
Alerting in Grafana allows you to attach rules to your dashboard panels. When you save the dashboard, |
||||
Grafana will extract the alert rules into a separate alert rule storage and schedule them for evaluation. |
||||
|
||||
{{< imgbox max-width="40%" img="/img/docs/v4/drag_handles_gif.gif" caption="Alerting overview" >}} |
||||
|
||||
In the alert tab of the graph panel you can configure how often the alert rule should be evaluated |
||||
and the conditions that need to be met for the alert to change state and trigger its |
||||
[notifications]({{< relref "notifications.md" >}}). |
||||
|
||||
## Execution |
||||
|
||||
The alert rules are evaluated in the Grafana backend in a scheduler and query execution engine that is part |
||||
of core Grafana. Only some data sources are supported right now. They include `Graphite`, `Prometheus`, `InfluxDB`, `Elasticsearch`, |
||||
`Stackdriver`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Data Explorer`. |
||||
|
||||
## Clustering |
||||
|
||||
Currently alerting supports a limited form of high availability. Since v4.2.0 of Grafana, alert notifications are deduped when running multiple servers. This means all alerts are executed on every server but no duplicate alert notifications are sent due to the deduping logic. Proper load balancing of alerts will be introduced in the future. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
## Rule Config |
||||
|
||||
Currently only the graph panel supports alert rules. |
||||
|
||||
### Name and Evaluation interval |
||||
|
||||
Here you can specify the name of the alert rule and how often the scheduler should evaluate the alert rule. |
||||
**Note:** You can set a minimum interval in the `alerting.min_interval_seconds` config field, to set a minimum time between evaluations. Check out the [[configuration]]({{< relref "../installation/configuration.md" >}}#min-interval-seconds) page for more information. |
||||
|
||||
### For |
||||
|
||||
> **Important note regarding No Data:** |
||||
> |
||||
> Do not use `For` with the `If no data or all values are null` setting set to `No Data`. The triggering of `No Data` will trigger instantly and not take `For` into consideration. This may also result in that an OK notification not being sent if alert transitions from `No Data -> Pending -> OK`. |
||||
|
||||
If an alert rule has a configured `For` and the query violates the configured threshold it will first go from `OK` to `Pending`. Going from `OK` to `Pending` Grafana will not send any notifications. Once the alert rule has been firing for more than `For` duration, it will change to `Alerting` and send alert notifications. |
||||
|
||||
Typically, it's always a good idea to use this setting since it's often worse to get false positive than wait a few minutes before the alert notification triggers. Looking at the `Alert list` or `Alert list panels` you will be able to see alerts in pending state. |
||||
|
||||
Below you can see an example timeline of an alert using the `For` setting. At ~16:04 the alert state changes to `Pending` and after 4 minutes it changes to `Alerting` which is when alert notifications are sent. Once the series falls back to normal the alert rule goes back to `OK`. |
||||
{{< imgbox img="/img/docs/v54/alerting-for-dark-theme.png" caption="Alerting For" >}} |
||||
|
||||
{{< imgbox max-width="40%" img="/img/docs/v4/alerting_conditions.png" caption="Alerting Conditions" >}} |
||||
|
||||
### Conditions |
||||
|
||||
Currently the only condition type that exists is a `Query` condition that allows you to |
||||
specify a query letter, time range and an aggregation function. |
||||
|
||||
### Query condition example |
||||
|
||||
```sql |
||||
avg() OF query(A, 15m, now) IS BELOW 14 |
||||
``` |
||||
|
||||
- `avg()` Controls how the values for **each** series should be reduced to a value that can be compared against the threshold. Click on the function to change it to another aggregation function. |
||||
- `query(A, 15m, now)` The letter defines what query to execute from the **Metrics** tab. The second two parameters define the time range, `15m, now` means 15 minutes ago to now. You can also do `10m, now-2m` to define a time range that will be 10 minutes ago to 2 minutes ago. This is useful if you want to ignore the last 2 minutes of data. |
||||
- `IS BELOW 14` Defines the type of threshold and the threshold value. You can click on `IS BELOW` to change the type of threshold. |
||||
|
||||
The query used in an alert rule cannot contain any template variables. Currently we only support `AND` and `OR` operators between conditions and they are executed serially. |
||||
For example, we have 3 conditions in the following order: |
||||
*condition:A(evaluates to: TRUE) OR condition:B(evaluates to: FALSE) AND condition:C(evaluates to: TRUE)* |
||||
so the result will be calculated as ((TRUE OR FALSE) AND TRUE) = TRUE. |
||||
|
||||
We plan to add other condition types in the future, like `Other Alert`, where you can include the state |
||||
of another alert in your conditions, and `Time Of Day`. |
||||
|
||||
#### Multiple Series |
||||
|
||||
If a query returns multiple series then the aggregation function and threshold check will be evaluated for each series. |
||||
What Grafana does not do currently is track alert rule state **per series**. This has implications that are detailed |
||||
in the scenario below. |
||||
|
||||
- Alert condition with query that returns 2 series: **server1** and **server2** |
||||
- **server1** series causes the alert rule to fire and switch to state `Alerting` |
||||
- Notifications are sent out with message: _load peaking (server1)_ |
||||
- In a subsequence evaluation of the same alert rule the **server2** series also cause the alert rule to fire |
||||
- No new notifications are sent as the alert rule is already in state `Alerting`. |
||||
|
||||
So as you can see from the above scenario Grafana will not send out notifications when other series cause the alert |
||||
to fire if the rule already is in state `Alerting`. To improve support for queries that return multiple series |
||||
we plan to track state **per series** in a future release. |
||||
|
||||
> Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications |
||||
> when an alert continues to fire. If other series (like server2 in the example above) also cause the alert rule to fire they will |
||||
> be included in the reminder notification. Depending on what notification channel you're using you may be able to take advantage |
||||
> of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here]({{< relref "notifications/#send-reminders" >}}). |
||||
|
||||
### No Data / Null values |
||||
|
||||
Below your conditions you can configure how the rule evaluation engine should handle queries that return no data or only null values. |
||||
|
||||
No Data Option | Description |
||||
------------ | ------------- |
||||
NoData | Set alert rule state to `NoData` |
||||
Alerting | Set alert rule state to `Alerting` |
||||
Keep Last State | Keep the current alert rule state, what ever it is. |
||||
|
||||
### Execution errors or timeouts |
||||
|
||||
The last option tells how to handle execution or timeout errors. |
||||
|
||||
Error or timeout option | Description |
||||
------------ | ------------- |
||||
Alerting | Set alert rule state to `Alerting` |
||||
Keep Last State | Keep the current alert rule state, what ever it is. |
||||
|
||||
If you have an unreliable time series store from which queries sometime timeout or fail randomly you can set this option |
||||
to `Keep Last State` in order to basically ignore them. |
||||
|
||||
## Notifications |
||||
|
||||
In alert tab you can also specify alert rule notifications along with a detailed message about the alert rule. |
||||
The message can contain anything, information about how you might solve the issue, link to runbook, etc. |
||||
|
||||
The actual notifications are configured and shared between multiple alerts. Read the |
||||
[notifications]({{< relref "notifications.md" >}}) guide for how to configure and setup notifications. |
||||
|
||||
## Alert State History and Annotations |
||||
|
||||
Alert state changes are recorded in the internal annotation table in Grafana's database. The state changes |
||||
are visualized as annotations in the alert rule's graph panel. You can also go into the `State history` |
||||
submenu in the alert tab to view and clear state history. |
||||
|
||||
## Troubleshooting |
||||
|
||||
{{< imgbox max-width="40%" img="/img/docs/v4/alert_test_rule.png" caption="Test Rule" >}} |
||||
|
||||
First level of troubleshooting you can do is hit the **Test Rule** button. You will get result back that you can expand |
||||
to the point where you can see the raw data that was returned from your query. |
||||
|
||||
Further troubleshooting can also be done by inspecting the grafana-server log. If it's not an error or for some reason |
||||
the log does not say anything you can enable debug logging for some relevant components. This is done |
||||
in Grafana's ini config file. |
||||
|
||||
Example showing loggers that could be relevant when troubleshooting alerting. |
||||
|
||||
```ini |
||||
[log] |
||||
filters = alerting.scheduler:debug \ |
||||
alerting.engine:debug \ |
||||
alerting.resultHandler:debug \ |
||||
alerting.evalHandler:debug \ |
||||
alerting.evalContext:debug \ |
||||
alerting.extractor:debug \ |
||||
alerting.notifier:debug \ |
||||
alerting.notifier.slack:debug \ |
||||
alerting.notifier.pagerduty:debug \ |
||||
alerting.notifier.email:debug \ |
||||
alerting.notifier.webhook:debug \ |
||||
tsdb.graphite:debug \ |
||||
tsdb.prometheus:debug \ |
||||
tsdb.opentsdb:debug \ |
||||
tsdb.influxdb:debug \ |
||||
tsdb.elasticsearch:debug \ |
||||
tsdb.elasticsearch.client:debug \ |
||||
``` |
||||
|
||||
If you want to log raw query sent to your TSDB and raw response in log you also have to set grafana.ini option `app_mode` to |
||||
`development`. |
||||
@ -0,0 +1,45 @@ |
||||
+++ |
||||
title = "Troubleshoot alerts" |
||||
description = "Troubleshoot alert rules" |
||||
keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Troubleshoot alerts" |
||||
parent = "alerting" |
||||
weight = 500 |
||||
+++ |
||||
|
||||
# Troubleshoot alerts |
||||
|
||||
If alerts are not behaving as you expect, here are some steps you can take to troubleshoot and figure out what is going wrong. |
||||
|
||||
{{< imgbox max-width="1000px" img="/img/docs/v4/alert_test_rule.png" caption="Test Rule" >}} |
||||
|
||||
The first level of troubleshooting you can do is click **Test Rule**. You will get result back that you can expand to the point where you can see the raw data that was returned from your query. |
||||
|
||||
Further troubleshooting can also be done by inspecting the grafana-server log. If it's not an error or for some reason the log does not say anything you can enable debug logging for some relevant components. This is done in Grafana's ini config file. |
||||
|
||||
Example showing loggers that could be relevant when troubleshooting alerting. |
||||
|
||||
```ini |
||||
[log] |
||||
filters = alerting.scheduler:debug \ |
||||
alerting.engine:debug \ |
||||
alerting.resultHandler:debug \ |
||||
alerting.evalHandler:debug \ |
||||
alerting.evalContext:debug \ |
||||
alerting.extractor:debug \ |
||||
alerting.notifier:debug \ |
||||
alerting.notifier.slack:debug \ |
||||
alerting.notifier.pagerduty:debug \ |
||||
alerting.notifier.email:debug \ |
||||
alerting.notifier.webhook:debug \ |
||||
tsdb.graphite:debug \ |
||||
tsdb.prometheus:debug \ |
||||
tsdb.opentsdb:debug \ |
||||
tsdb.influxdb:debug \ |
||||
tsdb.elasticsearch:debug \ |
||||
tsdb.elasticsearch.client:debug \ |
||||
``` |
||||
|
||||
If you want to log raw query sent to your TSDB and raw response in log you also have to set grafana.ini option `app_mode` to `development`. |
||||
@ -0,0 +1,23 @@ |
||||
+++ |
||||
title = "View alerts" |
||||
description = "View existing alert rules" |
||||
keywords = ["grafana", "alerting", "guide", "rules", "view"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "View alerts" |
||||
parent = "alerting" |
||||
weight = 400 |
||||
+++ |
||||
|
||||
# View existing alert rules |
||||
|
||||
Grafana stores individual alert rules in the panels where they are defined, but you can also view a list of all existing alert rules and their current state. |
||||
|
||||
In the Grafana side bar, hover your cursor over the Alerting (bell) icon and then click **Alert Rules**. All configured alert rules are listed, along with their current state. |
||||
|
||||
You can do several things while viewing alerts. |
||||
|
||||
- **Filter alerts by name -** Type an alert name in the **Search alerts** field. |
||||
- **Filter alerts by state -** In **States**, select which alert states you want to see. All others will be hidden. |
||||
- **Pause or resume an alert -** Click the **Pause** or **Play** icon next to the alert to pause or resume evaluation. See [Pause an alert rule]({{< relref "pause-an-alert-rule.md" >}}) for more information. |
||||
- **Access alert rule settings -** Click the alert name or the **Edit alert rule** (gear) icon. Grafana opens the Alert tab of the panel where the alert rule is defined. This is helpful when an alert is firing but you don't know which panel it is defined in. |
||||
Loading…
Reference in new issue