From 445291eb80357bb2f4ecb7dbd24c4d7b6de18e8b Mon Sep 17 00:00:00 2001 From: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Date: Fri, 20 Nov 2020 03:30:30 -0500 Subject: [PATCH] Docs: Fixed broken relrefs and chanfed TOC entry name from Alerting to Alerts. (#29251) --- docs/sources/administration/configuration.md | 2 +- docs/sources/alerting/_index.md | 3 +- docs/sources/alerting/alerts-overview.md | 54 ------------------- docs/sources/datasources/azuremonitor.md | 6 +-- docs/sources/datasources/cloudwatch.md | 2 +- docs/sources/getting-started/_index.md | 2 +- docs/sources/installation/requirements.md | 2 +- docs/sources/panels/add-a-panel.md | 2 +- .../panels/visualizations/alert-list-panel.md | 2 +- .../panels/visualizations/graph-panel.md | 2 +- docs/sources/whatsnew/whats-new-in-v6-5.md | 2 +- docs/sources/whatsnew/whats-new-in-v7-0.md | 2 +- 12 files changed, 14 insertions(+), 67 deletions(-) delete mode 100644 docs/sources/alerting/alerts-overview.md diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md index 794e2c43746..05d6e5fedbb 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/administration/configuration.md @@ -960,7 +960,7 @@ Sets a global limit on number of users that can be logged in at one time. Defaul ## [alerting] -For more information about the Alerting feature in Grafana, refer to [Alerts overview]({{< relref "../alerting/alerts-overview.md" >}}). +For more information about the Alerting feature in Grafana, refer to [Alerts overview]({{< relref "../alerting/_index.md" >}}). ### enabled diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index cac8c33e398..c8141aeb880 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -1,5 +1,6 @@ +++ -title = "Alerting" +title = "Alerts" +aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"] weight = 100 +++ diff --git a/docs/sources/alerting/alerts-overview.md b/docs/sources/alerting/alerts-overview.md deleted file mode 100644 index 558da54de35..00000000000 --- a/docs/sources/alerting/alerts-overview.md +++ /dev/null @@ -1,54 +0,0 @@ -+++ -title = "Alerts overview" -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`, -`Google Cloud Monitoring`, `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` - - \ No newline at end of file diff --git a/docs/sources/datasources/azuremonitor.md b/docs/sources/datasources/azuremonitor.md index 4340de1cece..09b2075587e 100644 --- a/docs/sources/datasources/azuremonitor.md +++ b/docs/sources/datasources/azuremonitor.md @@ -159,7 +159,7 @@ Not all metrics returned by the Azure Monitor API have values. To make it easier ### Azure Monitor alerting -Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. For more information about Grafana alerting, refer to [how alerting in Grafana works]({{< relref "../alerting/alerts-overview.md" >}}). +Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. For more information about Grafana alerting, refer to [how alerting in Grafana works]({{< relref "../alerting/_index.md" >}}). {{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}} @@ -221,7 +221,7 @@ Examples: ### Application Insights alerting -Grafana alerting is supported for Application Insights. This is not Azure Alerts support. For more information about Grafana alerting, refer to [Alerts overview]({{< relref "../alerting/alerts-overview.md" >}}). +Grafana alerting is supported for Application Insights. This is not Azure Alerts support. For more information about Grafana alerting, refer to [Alerts overview]({{< relref "../alerting/_index.md" >}}). {{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}} @@ -369,7 +369,7 @@ If you're not currently logged in to the Azure Portal, then the link opens the l > Only available in Grafana v7.0+. -Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works in [Alerting rules]({{< relref "../alerting/alerts-overview.md" >}}). +Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works in [Alerting rules]({{< relref "../alerting/_index.md" >}}). ## Query the Application Insights Analytics service diff --git a/docs/sources/datasources/cloudwatch.md b/docs/sources/datasources/cloudwatch.md index 84ef0198c5d..612a6dfa637 100644 --- a/docs/sources/datasources/cloudwatch.md +++ b/docs/sources/datasources/cloudwatch.md @@ -218,7 +218,7 @@ If you're not currently logged in to the CloudWatch console, the link will forwa ### Alerting Since CloudWatch Logs queries can return numeric data, for example through the use of the `stats` command, alerts are supported. -See the [Alerting]({{< relref "../alerting/alerts-overview.md" >}}) documentation for more on Grafana alerts. +See the [Alerting]({{< relref "../alerting/_index.md" >}}) documentation for more on Grafana alerts. ## Curated dashboards diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index bec11b6931d..7389aead947 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -28,7 +28,7 @@ Refer to [Explore]({{< relref "../explore/index.md" >}}) for more information. If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. -Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerts-overview.md" >}}) for your most important metrics. +Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/_index.md" >}}) for your most important metrics. ## Annotations diff --git a/docs/sources/installation/requirements.md b/docs/sources/installation/requirements.md index 62ca8ec9ecc..1616b236b85 100644 --- a/docs/sources/installation/requirements.md +++ b/docs/sources/installation/requirements.md @@ -32,7 +32,7 @@ Minimum recommended CPU: 1 Some features might require more memory or CPUs. Features require more resources include: - [Server side rendering of images]({{< relref "../administration/image_rendering/#requirements" >}}) -- [Alerting]({{< relref "../alerting/alerts-overview" >}}) +- [Alerting]({{< relref "../alerting" >}}) - [Data source proxy]({{< relref "../http_api/data_source" >}}) ## Supported databases diff --git a/docs/sources/panels/add-a-panel.md b/docs/sources/panels/add-a-panel.md index f77de79665e..e29b0cf0b6b 100644 --- a/docs/sources/panels/add-a-panel.md +++ b/docs/sources/panels/add-a-panel.md @@ -56,5 +56,5 @@ Our Grafana Fundamentals tutorial is a great place to start, or you can learn mo - [Transform]({{< relref "transformations/_index.md" >}}) your data. - [Configure]({{< relref "field-options/_index.md" >}}) how your results are displayed in the visualization. -- If you made a graph panel, set up an [alert]({{< relref "../alerting/alerts-overview.md" >}}). +- If you made a graph panel, set up an [alert]({{< relref "../alerting/_index.md" >}}). - Create [templates and variables]({{< relref "../variables/_index.md" >}}). diff --git a/docs/sources/panels/visualizations/alert-list-panel.md b/docs/sources/panels/visualizations/alert-list-panel.md index b5d35c065ca..5181a56d3e3 100644 --- a/docs/sources/panels/visualizations/alert-list-panel.md +++ b/docs/sources/panels/visualizations/alert-list-panel.md @@ -7,7 +7,7 @@ weight = 100 # Alert list panel -The Alert list panel allows you to display your dashboards alerts. You can configure the list to show current state or recent state changes. You can read more about alerts in [Alerts overview]({{< relref "../../alerting/alerts-overview.md" >}}). +The Alert list panel allows you to display your dashboards alerts. You can configure the list to show current state or recent state changes. You can read more about alerts in [Alerts overview]({{< relref "../../alerting/_index.md" >}}). {{< docs-imagebox img="/img/docs/v45/alert-list-panel.png" max-width="850px" >}} diff --git a/docs/sources/panels/visualizations/graph-panel.md b/docs/sources/panels/visualizations/graph-panel.md index 282a334b748..7187d959107 100644 --- a/docs/sources/panels/visualizations/graph-panel.md +++ b/docs/sources/panels/visualizations/graph-panel.md @@ -13,7 +13,7 @@ This visualization is the most-used in the Grafana ecosystem. It can render as a Graph visualizations allow you to apply: -- [Alerts]({{< relref "../../alerting/alerts-overview.md" >}}) - This is the only type of visualization that allows you to set alerts. +- [Alerts]({{< relref "../../alerting/_index.md" >}}) - This is the only type of visualization that allows you to set alerts. - [Data transformations]({{< relref "../transformations/_index.md" >}}) - [Field options and overrides]({{< relref "../field-options/_index.md" >}}) - [Thresholds]({{< relref "../thresholds.md" >}}) diff --git a/docs/sources/whatsnew/whats-new-in-v6-5.md b/docs/sources/whatsnew/whats-new-in-v6-5.md index ee2141e388f..43412b3ac69 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-5.md +++ b/docs/sources/whatsnew/whats-new-in-v6-5.md @@ -172,7 +172,7 @@ In the Explore split view, you can now link the two timepickers so that if you c ### Alerting support for Azure Application Insights -The [Azure Monitor]({{< relref "../datasources/azuremonitor/" >}}) data source supports multiple services in the Azure cloud. Before Grafana v6.5, only the Azure Monitor service had support for [Grafana Alerting]({{< relref "../alerting/alerts-overview" >}}). In Grafana 6.5, alerting support has been implemented for the [Application Insights service]({{< relref "../datasources/azuremonitor/#querying-the-application-insights-service" >}}). +The [Azure Monitor]({{< relref "../datasources/azuremonitor/" >}}) data source supports multiple services in the Azure cloud. Before Grafana v6.5, only the Azure Monitor service had support for [Grafana Alerting]({{< relref "../alerting" >}}). In Grafana 6.5, alerting support has been implemented for the [Application Insights service]({{< relref "../datasources/azuremonitor/#querying-the-application-insights-service" >}}). ### Allow saving of provisioned dashboards from UI diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index 646c7c2a846..93feae3b051 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -142,7 +142,7 @@ Plugins can be monitored with the new metrics and health check capabilities. The With this release, we are deprecating the unofficial first version of backend plugins which will be removed in a future release. -To learn more, start with the [overview]({{< relref "../developers/plugins/backend/_index.md" >}}). Next, in this [tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting]({{< relref "../alerting/alerts-overview.md" >}}). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. +To learn more, start with the [overview]({{< relref "../developers/plugins/backend/_index.md" >}}). Next, in this [tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting]({{< relref "../alerting/_index.md" >}}). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. ## New tutorials