mirror of
https://github.com/grafana/grafana.git
synced 2025-08-03 04:22:13 +08:00
Enable doc-validator for alerting directories (#68964)
* Enable doc-validator for alerting directories Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Adds missing description frontmatter * Fix some more links Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix some more links Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fixes anchors --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
This commit is contained in:
Jack Baldry
@ -2,6 +2,7 @@
|
||||
aliases:
|
||||
- metrics/
|
||||
- unified-alerting/fundamentals/
|
||||
description: Intro to the key concepts in Alerting and how it works
|
||||
title: Introduction to Alerting
|
||||
weight: 105
|
||||
---
|
||||
|
||||
@ -16,7 +16,7 @@ While queries and expressions select the data set to evaluate, a condition sets
|
||||
|
||||
An interval specifies how frequently an alerting rule is evaluated. Duration, when configured, indicates how long a condition must be met. The alert rules can also define alerting behavior in the absence of data.
|
||||
|
||||
- [Alert rule types]({{< relref "alert-rule-types/" >}})
|
||||
- [Alert instances]({{< relref "alert-instances/" >}})
|
||||
- [Organising alert rules]({{< relref "organising-alerts/" >}})
|
||||
- [Annotation and labels]({{< relref "../annotation-label/" >}})
|
||||
- [Alert rule types]({{< relref "./alert-rule-types" >}})
|
||||
- [Alert instances]({{< relref "./alert-instances" >}})
|
||||
- [Organising alert rules]({{< relref "./organising-alerts" >}})
|
||||
- [Annotation and labels]({{< relref "../annotation-label" >}})
|
||||
|
||||
@ -39,7 +39,7 @@ To create Grafana Mimir or Grafana Loki-managed alert rules, you must have a com
|
||||
|
||||
You can check if your data source supports rule creation via Grafana by testing the data source and observing if the Ruler API is supported.
|
||||
|
||||
For more information on the Ruler API, refer to [Ruler API](docs/loki/latest/api/#ruler).
|
||||
For more information on the Ruler API, refer to [Ruler API](/docs/loki/latest/api/#ruler).
|
||||
|
||||
The following diagram shows how Grafana Mimir or Grafana Loki-managed alerting works.
|
||||
|
||||
|
||||
@ -17,11 +17,11 @@ This topic explains why labels are a fundamental component of alerting.
|
||||
- The Alertmanager uses labels to match alerts for silences and alert groups in notification policies.
|
||||
- The alerting UI shows labels for every alert instance generated during evaluation of that rule.
|
||||
- Contact points can access labels to dynamically generate notifications that contain information specific to the alert that is resulting in a notification.
|
||||
- You can add labels to an [alerting rule]({{< relref "/docs/grafana/latest/alerting/alerting-rules" >}}). Labels are manually configurable, use template functions, and can reference other labels. Labels added to an alerting rule take precedence in the event of a collision between labels (except in the case of [Grafana reserved labels](#grafana-reserved-labels)).
|
||||
- You can add labels to an [alerting rule]({{< relref "../../alerting-rules" >}}). Labels are manually configurable, use template functions, and can reference other labels. Labels added to an alerting rule take precedence in the event of a collision between labels (except in the case of [Grafana reserved labels](#grafana-reserved-labels)).
|
||||
|
||||
{{< figure src="/static/img/docs/alerting/unified/rule-edit-details-8-0.png" max-width="550px" caption="Alert details" >}}
|
||||
|
||||
# External Alertmanager Compatibility
|
||||
## External Alertmanager Compatibility
|
||||
|
||||
Grafana's built-in Alertmanager supports both Unicode label keys and values. If you are using an external Prometheus Alertmanager, label keys must be compatible with their [data model](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
|
||||
This means that label keys must only contain **ASCII letters**, **numbers**, as well as **underscores** and match the regex `[a-zA-Z_][a-zA-Z0-9_]*`.
|
||||
@ -35,11 +35,11 @@ Example: A label key/value pair `Alert! 🔔="🔥"` will become `Alert_0x1f514=
|
||||
|
||||
**Note** If multiple label keys are sanitized to the same value, the duplicates will have a short hash of the original label appended as a suffix.
|
||||
|
||||
# Grafana reserved labels
|
||||
## Grafana reserved labels
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
Labels prefixed with `grafana_` are reserved by Grafana for special use. If a manually configured label is added beginning with `grafana_` it may be overwritten in case of collision.
|
||||
To stop the Grafana Alerting engine from adding a reserved label, you can disable it via the `disabled_labels` option in [unified_alerting.reserved_labels]({{< relref "/docs/grafana/latest/setup-grafana/configure-grafana#unified_alertingreserved_labels" >}}) configuration.
|
||||
To stop the Grafana Alerting engine from adding a reserved label, you can disable it via the `disabled_labels` option in [unified_alerting.reserved_labels]({{< relref "../../../setup-grafana/configure-grafana#unified_alertingreserved_labels" >}}) configuration.
|
||||
{{% /admonition %}}
|
||||
|
||||
Grafana reserved labels can be used in the same way as manually configured labels. The current list of available reserved labels are:
|
||||
|
||||
@ -5,7 +5,8 @@ keywords:
|
||||
- alerting
|
||||
- guide
|
||||
- fundamentals
|
||||
title: Label matchers
|
||||
title: How label matching works
|
||||
menuTitle: Label matchers
|
||||
weight: 117
|
||||
---
|
||||
|
||||
|
||||
@ -164,7 +164,7 @@ https://example.com/grafana
|
||||
|
||||
### graphLink
|
||||
|
||||
The `graphLink` function returns the path to the graphical view in [Explore](https://grafana.com/docs/grafana/latest/explore/) for the given expression and data source.
|
||||
The `graphLink` function returns the path to the graphical view in [Explore]({{< relref "../../../explore" >}}) for the given expression and data source.
|
||||
|
||||
#### Example
|
||||
|
||||
@ -276,7 +276,7 @@ The `pathPrefix` function returns the path of the Grafana server as configured i
|
||||
|
||||
### tableLink
|
||||
|
||||
The `tableLink` function returns the path to the tabular view in [Explore](https://grafana.com/docs/grafana/latest/explore/) for the given expression and data source.
|
||||
The `tableLink` function returns the path to the tabular view in [Explore]({{< relref "../../../explore" >}}) for the given expression and data source.
|
||||
|
||||
#### Example
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ The following table lists the contact point integrations supported by Grafana.
|
||||
| ------------------------------------------------ | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| [DingDing](https://www.dingtalk.com/en) | `dingding` | Supported | N/A |
|
||||
| [Discord](https://discord.com/) | `discord` | Supported | N/A |
|
||||
| [Email](#email) | `email` | Supported | Supported |
|
||||
| Email | `email` | Supported | Supported |
|
||||
| [Google Hangouts](https://hangouts.google.com/) | `googlechat` | Supported | N/A |
|
||||
| [Kafka](https://kafka.apache.org/) | `kafka` | Supported | N/A |
|
||||
| [Line](https://line.me/en/) | `line` | Supported | N/A |
|
||||
@ -47,13 +47,13 @@ The following table lists the contact point integrations supported by Grafana.
|
||||
| [Telegram](https://telegram.org/) | `telegram` | Supported | N/A |
|
||||
| [Threema](https://threema.ch/) | `threema` | Supported | N/A |
|
||||
| [VictorOps](https://help.victorops.com/) | `victorops` | Supported | Supported |
|
||||
| [Webhook](#webhook) | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) |
|
||||
| [Cisco Webex Teams](#webex) | `webex` | Supported | Supported |
|
||||
| [WeCom](#wecom) | `wecom` | Supported | N/A |
|
||||
| Webhook | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) |
|
||||
| Cisco Webex Teams | `webex` | Supported | Supported |
|
||||
| WeCom | `wecom` | Supported | N/A |
|
||||
| [Zenduty](https://www.zenduty.com/) | `webhook` | Supported | N/A |
|
||||
|
||||
## Useful links
|
||||
|
||||
[Manage contact points](/docs/grafana/latest/alerting/manage-notifications/manage-contact-points/)
|
||||
[Manage contact points]({{< relref "../../manage-notifications/manage-contact-points" >}})
|
||||
|
||||
[Create and edit notification templates](/docs/grafana/latest/alerting/manage-notifications/template-notifications/create-notification-templates/)
|
||||
[Create and edit notification templates]({{< relref "../../manage-notifications/template-notifications/create-notification-templates" >}})
|
||||
|
||||
@ -6,32 +6,31 @@ weight: 100
|
||||
|
||||
# Data sources
|
||||
|
||||
There are a number of data sources that are compatible with Grafana Alerting. Each data source is supported by a plugin. You can use one of the built-in data sources listed below, use [external data source plugins](https://grafana.com/grafana/plugins/?type=datasource), or create your own data source plugin.
|
||||
There are a number of data sources that are compatible with Grafana Alerting. Each data source is supported by a plugin. You can use one of the built-in data sources listed below, use [external data source plugins](/grafana/plugins/?type=datasource), or create your own data source plugin.
|
||||
|
||||
If you are creating your own data source plugin, make sure it is a backend plugin as Grafana Alerting requires this in order to be able to evaluate rules using the data source. Frontend data sources are not supported, because the evaluation engine runs on the backend.
|
||||
|
||||
Specifying { "alerting": true, “backend”: true } in the plugin.json file indicates that the data source plugin is compatible with Grafana Alerting and includes the backend data-fetching code. For more information, refer to [Build a data source backend plugin](https://grafana.com/tutorials/build-a-data-source-backend-plugin/).
|
||||
Specifying { "alerting": true, “backend”: true } in the plugin.json file indicates that the data source plugin is compatible with Grafana Alerting and includes the backend data-fetching code. For more information, refer to [Build a data source backend plugin](/tutorials/build-a-data-source-backend-plugin/).
|
||||
|
||||
These are the data sources that are compatible with and supported by Grafana Alerting.
|
||||
|
||||
- [AWS CloudWatch](https://grafana.com/docs/grafana/latest/datasources/aws-cloudwatch/)
|
||||
- [Azure Monitor](https://grafana.com/docs/grafana/latest/datasources/azuremonitor/)
|
||||
- [Elasticsearch](https://grafana.com/docs/grafana/latest/datasources/elasticsearch/)
|
||||
- [Google Cloud Monitoring](https://grafana.com/docs/grafana/latest/datasources/google-cloud-monitoring/)
|
||||
- [Graphite](https://grafana.com/docs/grafana/latest/datasources/graphite/)
|
||||
- [InfluxDB](https://grafana.com/docs/grafana/latest/datasources/influxdb/)
|
||||
- [Loki](https://grafana.com/docs/grafana/latest/datasources/loki/)
|
||||
- [Microsoft SQL Server MSSQL](https://grafana.com/docs/grafana/latest/datasources/mssql/)
|
||||
- [MySQL](https://grafana.com/docs/grafana/latest/datasources/mysql/)
|
||||
- [Open TSDB](https://grafana.com/docs/grafana/latest/datasources/opentsdb/)
|
||||
- [PostgreSQL](https://grafana.com/docs/grafana/latest/datasources/postgres/)
|
||||
- [Prometheus](https://grafana.com/docs/grafana/latest/datasources/prometheus/)
|
||||
- [Jaeger](https://grafana.com/docs/grafana/latest/datasources/jaeger/)
|
||||
- [Zipkin](https://grafana.com/docs/grafana/latest/datasources/zipkin/)
|
||||
- [Tempo](https://grafana.com/docs/grafana/latest/datasources/tempo/)
|
||||
- [Testdata](https://grafana.com/docs/grafana/latest/datasources/testdata/)
|
||||
- [AWS CloudWatch]({{< relref "../../datasources/aws-cloudwatch" >}})
|
||||
- [Azure Monitor]({{< relref "../../datasources/azure-monitor" >}})
|
||||
- [Elasticsearch]({{< relref "../../datasources/elasticsearch" >}})
|
||||
- [Google Cloud Monitoring]({{< relref "../../datasources/google-cloud-monitoring" >}})
|
||||
- [Graphite]({{< relref "../../datasources/graphite" >}})
|
||||
- [InfluxDB]({{< relref "../../datasources/influxdb" >}})
|
||||
- [Loki]({{< relref "../../datasources/loki" >}})
|
||||
- [Microsoft SQL Server MSSQL]({{< relref "../../datasources/mssql" >}})
|
||||
- [MySQL]({{< relref "../../datasources/mysql" >}})
|
||||
- [Open TSDB]({{< relref "../../datasources/opentsdb" >}})
|
||||
- [PostgreSQL]({{< relref "../../datasources/postgres" >}})
|
||||
- [Prometheus]({{< relref "../../datasources/prometheus" >}})
|
||||
- [Jaeger]({{< relref "../../datasources/jaeger" >}})
|
||||
- [Zipkin]({{< relref "../../datasources/zipkin" >}})
|
||||
- [Tempo]({{< relref "../../datasources/tempo" >}})
|
||||
- [Testdata]({{< relref "../../datasources/testdata" >}})
|
||||
|
||||
## Useful links
|
||||
|
||||
- [Grafana data sources](https://grafana.com/docs/grafana/latest/datasources/)
|
||||
- [Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/)
|
||||
- [Grafana data sources]({{< relref "../../datasources" >}})
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
aliases:
|
||||
- ../metrics/
|
||||
- ../unified-alerting/fundamentals/evaluate-grafana-alerts/
|
||||
description: How to alert on numeric data
|
||||
title: Alerting on numeric data
|
||||
weight: 116
|
||||
---
|
||||
@ -23,11 +24,11 @@ Grafana managed alerts query the following backend data sources that have alerti
|
||||
|
||||
- built-in data sources or those developed and maintained by Grafana: `Graphite`, `Prometheus`, `Loki`, `InfluxDB`, `Elasticsearch`,
|
||||
`Google Cloud Monitoring`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Monitor`
|
||||
- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "/docs/grafana/latest/developers/plugins/metadata" >}}))
|
||||
- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../developers/plugins/metadata" >}}))
|
||||
|
||||
### Metrics from the alerting engine
|
||||
|
||||
The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "/docs/grafana/latest/setup-grafana/set-up-grafana-monitoring" >}}).
|
||||
The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../setup-grafana/set-up-grafana-monitoring" >}}).
|
||||
|
||||
| Metric Name | Type | Description |
|
||||
| ------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------- |
|
||||
|
||||
@ -32,4 +32,4 @@ The notification logs and silences are persisted in the database periodically an
|
||||
|
||||
## Useful links
|
||||
|
||||
[Configure alerting high availability](https://grafana.com/docs/grafana/next/alerting/set-up/configure-high-availability)
|
||||
[Configure alerting high availability]({{< relref "../../set-up/configure-high-availability" >}})
|
||||
|
||||
@ -45,7 +45,7 @@ The following table contains the integrations supported in Grafana:
|
||||
| ------------------------------------------------ | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| [DingDing](https://www.dingtalk.com/en) | `dingding` | Supported | N/A |
|
||||
| [Discord](https://discord.com/) | `discord` | Supported | N/A |
|
||||
| [Email](#email) | `email` | Supported | Supported |
|
||||
| Email | `email` | Supported | Supported |
|
||||
| [Google Hangouts](https://hangouts.google.com/) | `googlechat` | Supported | N/A |
|
||||
| [Kafka](https://kafka.apache.org/) | `kafka` | Supported | N/A |
|
||||
| [Line](https://line.me/en/) | `line` | Supported | N/A |
|
||||
@ -59,9 +59,9 @@ The following table contains the integrations supported in Grafana:
|
||||
| [Telegram](https://telegram.org/) | `telegram` | Supported | N/A |
|
||||
| [Threema](https://threema.ch/) | `threema` | Supported | N/A |
|
||||
| [VictorOps](https://help.victorops.com/) | `victorops` | Supported | Supported |
|
||||
| [Webhook](#webhook) | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) |
|
||||
| [Cisco Webex Teams](#webex) | `webex` | Supported | Supported |
|
||||
| [WeCom](#wecom) | `wecom` | Supported | N/A |
|
||||
| Webhook | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) |
|
||||
| Cisco Webex Teams | `webex` | Supported | Supported |
|
||||
| WeCom | `wecom` | Supported | N/A |
|
||||
| [Zenduty](https://www.zenduty.com/) | `webhook` | Supported | N/A |
|
||||
|
||||
## Templating notifications
|
||||
|
||||
Reference in New Issue
Block a user