docs: nav updates for alerting (#65300)

* navigation related updates - text only * navigation related updates * navigation related text updates * navigation related text updates * navigation related text and image updates
2023-03-23 13:26:16 -07:00
parent 0871b6aea9
commit a5c5db3e91
11 changed files with 104 additions and 78 deletions
@@ -20,31 +20,32 @@ Watch this video to learn more about creating alerts: {{< vimeo 720001934 >}}

 ## Add Grafana managed rule

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
-1. Click **Create alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules**.
+1. Click **+ Create alert rule**. The new alerting rule page opens where the **Grafana managed alerts** option is selected by default.
 1. In Step 1, add the rule name.
   - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
 1. In Step 2, add queries and expressions to evaluate, and then select the alert condition.
-   - For queries, select a data source from the drop-down.
+   - For queries, select a data source from the dropdown.
   - Add one or more [queries]({{< relref "/docs/grafana/latest/panels-visualizations/query-transform-data#add-a-query" >}}) or [expressions]({{< relref "/docs/grafana/latest/panels-visualizations/query-transform-data/expression-queries" >}}).
-   - For each expression, select either **Classic condition** to create a single alert rule, or choose from **Math**, **Reduce**, **Resample** options to generate separate alert for each series. For details on these options, see [Single and multi dimensional rule](#single-and-multi-dimensional-rule).
+   - For each expression, select either **Classic condition** to create a single alert rule, or choose from the **Math**, **Reduce**, and **Resample** options to generate separate alert for each series. For details on these options, see [Single and multi dimensional rule](#single-and-multi-dimensional-rule).
   - Click **Run queries** to verify that the query is successful.
   - Next, select the query or expression for your alert condition.
 1. In Step 3, specify the alert evaluation interval.

-   - From the **Condition** drop-down, select the query or expression to trigger the alert rule.
+   - From the **Condition** dropdown, select the query or expression to trigger the alert rule.
   - For **Evaluate every**, specify the frequency of evaluation. Must be a multiple of 10 seconds. For examples, `1m`, `30s`.
   - For **Evaluate for**, specify the duration for which the condition must be true before an alert fires.
     > **Note:** Once a condition is breached, the alert goes into the Pending state. If the condition remains breached for the duration specified, the alert transitions to the `Firing` state, otherwise it reverts back to the `Normal` state.
   - In **Configure no data and error handling**, configure alerting behavior in the absence of data. Use the guidelines in [No data and error handling](#no-data-and-error-handling).
-   - Click **Preview alerts** to check the result of running the query at this moment. Preview excludes no data and error handling.
+   - Click **Preview** to check the result of running the query at this moment. Preview excludes no data and error handling.

     **Note:**

     You can pause alert rule evaluation to prevent noisy alerting while tuning your alerts. Pausing stops alert rule evaluation and does not create any alert instances. This is different to mute timings, which stop notifications from being delivered, but still allow for alert rule evaluation and the creation of alert instances.

 1. In Step 4, add the storage location, rule group, as well as additional metadata associated with the rule.
-   - From the **Folder** drop-down, select the folder where you want to store the rule.
+   - From the **Folder** dropdown, select the folder where you want to store the rule.
   - For **Group**, specify a pre-defined group. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
   - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}).
   - Add Runbook URL, panel, dashboard, and alert IDs.
@@ -34,33 +34,37 @@ You can create and manage recording rules for an external Grafana Mimir or Loki

 To create a Grafana Mimir or Loki managed recording rule

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
-1. Click **Create alert rule**. The new alerting rule page opens where the **Grafana managed alert** option is selected by default.
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules**.
+1. Click **+ Create alert rule**. The new alerting rule page opens where the **Grafana managed alert** option is selected by default.
 1. In Step 1, add the rule name. The recording name must be a Prometheus metric name and contain no whitespace.
   - In **Rule name**, add a descriptive name.
 1. In Step 2, select **Mimir or Loki recording rule** option.
   - Select your Loki or Prometheus data source.
   - Enter a PromQL or LogQL query.
 1. In Step 3, add the namespace and the group.
-   - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click Add new and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
-   - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one.
+   - From the **Namespace** dropdown, select an existing rule namespace. Otherwise, click Add new and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
+   - From the **Group** dropdown, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one.
 1. In Step 4, add the custom labels.
   - Add custom labels selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
 1. Click **Save** to save the recording rule or **Save and exit** to save the recording rule and go back to the Alerting page.

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
-1. Click **Create alert rule**.
+<!-- delete next steps? -->
+
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules**.
+1. Click **+ Create alert rule**.
 1. In Step 1, add the rule name.
   - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
 1. In Step 2, add the type, and storage location.
-   - From the **Rule type** drop-down, select **Mimir / Loki managed alert**.
-   - From the **Select data source** drop-down, select an external Prometheus, an external Loki, or a Grafana Cloud data source.
+   - From the **Rule type** dropdown, select **Mimir / Loki managed alert**.
+   - From the **Select data source** dropdown, select an external Prometheus, an external Loki, or a Grafana Cloud data source.
   - Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series.
 1. In Step 3, add evaluation behavior.
   - Enter a valid **For** duration. The expression has to be true for this long for the alert to be fired.
 1. In Step 4, add additional metadata associated with the rule.
-   - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click Add new and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
-   - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
+   - From the **Namespace** dropdown, select an existing rule namespace. Otherwise, click Add new and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
+   - From the **Group** dropdown, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
   - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}).
   - Add Runbook URL, panel, dashboard, and alert IDs.
 1. In Step 5, add custom labels.
@@ -34,8 +34,9 @@ Watch this video to learn more about how to create a Mimir managed alert rule: {

 ## Add a Grafana Mimir or Loki managed alerting rule

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
-1. Click **Create alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules**.
+1. Click **+ Create alert rule**. The new alerting rule page opens where the **Grafana managed alerts** option is selected by default.
 1. In Step 1, add the rule name.
   - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
 1. In Step 2, select **Mimir or Loki alert** option.
@@ -45,8 +46,8 @@ Watch this video to learn more about how to create a Mimir managed alert rule: {
   - In the **For** text box, specify the duration for which the condition must be true before an alert fires. If you specify `5m`, the condition must be true for 5 minutes before the alert fires.
     > **Note:** Once a condition is met, the alert goes into the `Pending` state. If the condition remains active for the duration specified, the alert transitions to the `Firing` state, else it reverts to the `Normal` state.
 1. In Step 4, add the namespace, rule group, as well as additional metadata associated with the rule.
-   - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
-   - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
+   - From the **Namespace** dropdown, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}).
+   - From the **Group** dropdown, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time.
   - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}).
   - Add Runbook URL, panel, dashboard, and alert IDs.
 1. In Step 5, add custom labels.
@@ -19,15 +19,18 @@ weight: 405

 A namespace contains one or more groups. The rules within a group are run sequentially at a regular interval. The default interval is one (1) minute. You can rename Grafana Mimir or Loki rule namespaces and groups, and edit group evaluation intervals.

-![Group list](/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png 'Rule group list screenshot')
+{{< figure src="/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png" caption="Rule group list" alt="Group list" >}}

+<!-- image is the same as above
 {{< figure src="/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png" max-width="550px" caption="Alert details" >}}
+-->

 ## Rename a namespace

 To rename a namespace:

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules** to view the list of existing alerts.
 1. Find a Grafana Mimir or Loki managed rule with the group that belongs to the namespace you want to edit.
 1. Click the **Edit** (pen) icon.
 1. Enter a new name in the **Namespace** field, then click **Save changes**.
@@ -38,7 +41,8 @@ A new namespace is created and all groups are copied into this namespace from th

 The rules within a group are run sequentially at a regular interval, the default interval is one (1) minute. You can modify this interval using the following instructions.

-1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
+1. In the left-side menu, click the **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules** to view the list of existing alerts.
 1. Find a Grafana Mimir or Loki managed rule with the group you want to edit.
 1. Click **Edit** (pen) icon.
 1. Modify the **Rule group** and **Rule group evaluation interval** information as necessary.
@@ -47,3 +51,7 @@ The rules within a group are run sequentially at a regular interval, the default
 When you rename the group, a new group with all the rules from the old group is created. The old group is deleted.

 ![Group edit modal](/static/img/docs/alerting/unified/rule-list-mimir-loki-edit-ns-group-8-2.png 'Rule group edit modal screenshot')
+
+<!-- new image that displays current 9.4 state of modal below
+{{< figure src="/media/docs/grafana/alerting/screenshot-rule-list-mimir-loki-edit-ns-group-9-4.png" max-width="550px" caption="Rule group edit modal" alt="Group edit modal" >}}
+-->
@@ -22,8 +22,9 @@ There are three key components: [alert rule state](#alert-rule-state), [alert in

 To view the state and health of your alert rules:

-1. Navigate to Alerting > Alert rules.
-2. Click an alert rule to view its state, health and state history.
+1. In the left-side menu, click **Alerts & incidents** and then **Alerting**.
+1. Click **Alert rules** to view the list of existing alerts.
+1. Click an alert rule to view its state, health, and state history.

 ## Alert rule state