mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Alerting docs: fixes missing alt attributes (#88235)
* Fix missing `alt` text in images
* Fix `canonical` setting in AlertManager docs
* Fix `.`(dot) position in hyperlinks due to a temporary styling issue
* Revert "Fix `canonical` setting in AlertManager docs"
This reverts commit 65354b3642.
This commit is contained in:
Pepe Cano
GitHub
parent
643018f94a
commit
33db776c91
@ -235,7 +235,7 @@ Annotations add metadata to provide more information on the alert in your alert
|
||||
|
||||
In **Configure no data and error handling**, you can define the alerting behavior when the evaluation returns no data or an error.
|
||||
|
||||
For details about alert states, refer to [lifecycle of alert instances.](ref:alert-instance-state)
|
||||
For details about alert states, refer to [lifecycle of alert instances](ref:alert-instance-state).
|
||||
|
||||
You can configure the alert instance state when its evaluation returns no data:
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ The criteria determining when an alert rule fires are based on two settings:
|
||||
- [Evaluation group](#evaluation-group): how frequently the alert rule is evaluated.
|
||||
- [Pending period](#pending-period): how long the condition must be met to start firing.
|
||||
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation.png" max-width="750px" caption="Set alert rule evaluation" >}}
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation.png" max-width="750px" alt="Set the evaluation behavior of the alert rule in Grafana." caption="Set alert rule evaluation" >}}
|
||||
|
||||
## Evaluation group
|
||||
|
||||
@ -57,7 +57,7 @@ Keep in mind:
|
||||
- Alert instances from the same alert rule may be in different states. For instance, only one observed machine might start firing.
|
||||
- Only **Alerting** and **Resolved** alert instances are routed to manage their notifications.
|
||||
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation-overview-statediagram-v2.png" max-width="750px" >}}
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation-overview-statediagram-v2.png" alt="A diagram of the alert instance states and when to route their notifications." max-width="750px" >}}
|
||||
|
||||
<!--
|
||||
Remove ///
|
||||
|
||||
@ -47,18 +47,18 @@ An alert instance can be in either of the following states:
|
||||
| State | Description |
|
||||
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Normal** | The state of an alert when the condition (threshold) is not met. |
|
||||
| **Pending** | The state of an alert that has breached the threshold but for less than the [pending period.](ref:pending-period) |
|
||||
| **Alerting** | The state of an alert that has breached the threshold for longer than the [pending period.](ref:pending-period) |
|
||||
| **NoData** | The state of an alert whose query returns no data or all values are null. You can [change the default behavior.](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling) |
|
||||
| **Error** | The state of an alert when an error or timeout occurred evaluating the alert rule. You can [change the default behavior.](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling) |
|
||||
| **Pending** | The state of an alert that has breached the threshold but for less than the [pending period](ref:pending-period). |
|
||||
| **Alerting** | The state of an alert that has breached the threshold for longer than the [pending period](ref:pending-period). |
|
||||
| **NoData** | The state of an alert whose query returns no data or all values are null. You can [change the default behavior](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling). |
|
||||
| **Error** | The state of an alert when an error or timeout occurred evaluating the alert rule. You can [change the default behavior](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling). |
|
||||
|
||||
{{< figure src="/media/docs/alerting/alert-instance-states-v3.png" caption="Alert instance state diagram" alt="Alert instance state diagram" max-width="750px" >}}
|
||||
{{< figure src="/media/docs/alerting/alert-instance-states-v3.png" caption="Alert instance state diagram" alt="A diagram of the distinct alert instance states and transitions." max-width="750px" >}}
|
||||
|
||||
### Notifications
|
||||
|
||||
Alert instances will be routed for [notifications](ref:notifications) when they are in the `Alerting` state or have been `Resolved`, transitioning from `Alerting` to `Normal` state.
|
||||
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation-overview-statediagram-v2.png" max-width="750px" >}}
|
||||
{{< figure src="/media/docs/alerting/alert-rule-evaluation-overview-statediagram-v2.png" alt="A diagram of the alert instance states and when to route their notifications." max-width="750px" >}}
|
||||
|
||||
### Lifecycle of stale alert instances
|
||||
|
||||
@ -72,7 +72,7 @@ The "Keep Last State" option helps mitigate temporary data source issues, preven
|
||||
|
||||
In [Configure no data and error handling,](ref:no-data-and-error-handling) you can decide to keep the last state of the alert instance when a `NoData` and/or `Error` state is encountered. Just like normal evaluation, the alert instance transitions from `Pending` to `Alerting` after the pending period has elapsed.
|
||||
|
||||
{{< figure src="/media/docs/alerting/alert-rule-configure-no-data-and-error.png" max-width="500px" >}}
|
||||
{{< figure src="/media/docs/alerting/alert-rule-configure-no-data-and-error.png" alt="A screenshot of the `Configure no data and error handling` option in Grafana Alerting." max-width="500px" >}}
|
||||
|
||||
However, in situations where strict monitoring is critical, relying solely on the "Keep Last State" option may not be appropriate. Instead, consider using an alternative or implementing additional alert rules to ensure that issues with prolonged data source disruptions are detected.
|
||||
|
||||
|
||||
@ -68,7 +68,7 @@ Some common types of query components include:
|
||||
**Grouping**: Group the data by specific dimensions or tags to create aggregated views or breakdowns.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
Grafana doesn't support alert queries with template variables. More details [here.](https://community.grafana.com/t/template-variables-are-not-supported-in-alert-queries-while-setting-up-alert/2514)
|
||||
Grafana doesn't support alert queries with template variables. More details [here](https://community.grafana.com/t/template-variables-are-not-supported-in-alert-queries-while-setting-up-alert/2514).
|
||||
{{% /admonition %}}
|
||||
|
||||
## Expression queries
|
||||
@ -81,7 +81,7 @@ In Alerting, you can only use expressions for Grafana-managed alert rules. For e
|
||||
|
||||
**Reduce**
|
||||
|
||||
Aggregates time series values in the selected time range into a single value. It's not necessary for [rules using numeric data.](#alert-on-numeric-data)
|
||||
Aggregates time series values in the selected time range into a single value. It's not necessary for [rules using numeric data](#alert-on-numeric-data).
|
||||
|
||||
**Math**
|
||||
|
||||
|
||||
@ -53,4 +53,4 @@ To declare an incident from a firing alert, complete the following steps.
|
||||
|
||||
View and track the incident in the Grafana Incident application.
|
||||
|
||||
For more information, refer to [Grafana Incident documentation.](/docs/grafana-cloud/incident/configure-settings/)
|
||||
For more information, refer to [Grafana Incident documentation](/docs/grafana-cloud/incident/configure-settings/).
|
||||
|
||||
@ -228,13 +228,13 @@ The **Alerting HTTP API** provides specific endpoints for exporting alerting res
|
||||
|
||||
| Resource | Method / URI | Summary |
|
||||
| ------------------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| Alert rules | GET /api/v1/provisioning/alert-rules/export | [Export all alert rules in provisioning file format.](ref:export_rules) |
|
||||
| Alert rules | GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export | [Export an alert rule group in provisioning file format.](ref:export_rule_group) |
|
||||
| Alert rules | GET /api/v1/provisioning/alert-rules/:uid/export | [Export an alert rule in provisioning file format.](ref:export_rule) |
|
||||
| Contact points | GET /api/v1/provisioning/contact-points/export | [Export all contact points in provisioning file format.](ref:export_contacts) |
|
||||
| Notification policy tree | GET /api/v1/provisioning/policies/export | [Export the notification policy tree in provisioning file format.](ref:export_notifications) |
|
||||
| Mute timings | GET /api/v1/provisioning/mute-timings/export | [Export all mute timings in provisioning file format.](ref:export_mute_timings) |
|
||||
| Mute timings | GET /api/v1/provisioning/mute-timings/:name/export | [Export a mute timing in provisioning file format.](ref:export_mute_timing) |
|
||||
| Alert rules | GET /api/v1/provisioning/alert-rules/export | [Export all alert rules in provisioning file format](ref:export_rules). |
|
||||
| Alert rules | GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export | [Export an alert rule group in provisioning file format](ref:export_rule_group). |
|
||||
| Alert rules | GET /api/v1/provisioning/alert-rules/:uid/export | [Export an alert rule in provisioning file format](ref:export_rule). |
|
||||
| Contact points | GET /api/v1/provisioning/contact-points/export | [Export all contact points in provisioning file format](ref:export_contacts). |
|
||||
| Notification policy tree | GET /api/v1/provisioning/policies/export | [Export the notification policy tree in provisioning file format](ref:export_notifications). |
|
||||
| Mute timings | GET /api/v1/provisioning/mute-timings/export | [Export all mute timings in provisioning file format](ref:export_mute_timings). |
|
||||
| Mute timings | GET /api/v1/provisioning/mute-timings/:name/export | [Export a mute timing in provisioning file format](ref:export_mute_timing). |
|
||||
|
||||
These endpoints accept a `download` parameter to download a file containing the exported resources.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user