docs: Minor tweaks to the Grafana Fundamentals tutorial (#86777)

* Minor tweaks to the Grafana Fundamentals tutorial

* Replaced old note style with admonition shortcode

* trigger CI

* Fixed shortcode

Co-authored-by: Danielle Broadwater <danibroadwater@outlook.com>

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Danielle Broadwater <danibroadwater@outlook.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Tom Glenn 2024-05-02 21:44:59 +01:00 committed by GitHub
parent 21afe3dc62
commit e95eaa9302
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -338,7 +338,8 @@ Now that Grafana knows how to notify us, it's time to set up an alert rule:
1. In the Evaluation group, repeat the above step to create a new one. We will name it `fundamentals` too.
1. Choose an Evaluation interval (how often the alert will be evaluated). For example, every `10s` (10 seconds).
1. Set the pending period. This is the time that a condition has to be met until the alert enters in Firing state and a notification is sent. Enter `0s`. For the purposes of this tutorial, the evaluation interval is intentionally short. This makes it easier to test. This setting makes Grafana wait until an alert has fired for a given time before Grafana sends the notification.
1. In **Section 4**, you can optionally add some sample text to your summary message. [Read more about message templating here](/docs/grafana/latest/alerting/unified-alerting/message-templating/).
1. In **Section 4**, choose **RequestBin** as the **Contact point**.
1. In **Section 5**, you can optionally add some sample text to your summary message. [Read more about message templating here](/docs/grafana/latest/alerting/unified-alerting/message-templating/).
1. Click **Save rule and exit** at the top of the page.
1. In Grafana's sidebar, navigate to **Notification policies**.
1. Under **Default policy**, select **...** &rsaquo; **Edit** and change the **Default contact point** from **grafana-default-email** to **RequestBin**.
@ -357,6 +358,10 @@ We have now configured an alert rule and a contact point. Now let's see if we ca
Once the query `sum(rate(tns_request_duration_seconds_count[5m])) by(route)` returns a value greater than `0.2` Grafana will trigger our alert. Browse to the Request Bin we created earlier and find the sent Grafana alert notification with details and metadata.
{{< admonition type="note" >}}
The alert may be triggered by the `/metrics` endpoint which is frequently accessed by Grafana when pulling metrics from the application. If this happens, you can increase the **Threshold** value in **Section 2** for testing purposes.
{{< /admonition >}}
### Display Grafana Alerts to your dashboard
In most cases, it's also valuable to display Grafana Alerts as annotations to your dashboard. Check out the video tutorial below to learn how to display alerting to your dashboard.
@ -367,7 +372,7 @@ Let's see how we can configure this.
1. In Grafana's sidebar, hover over the **Alerting** (bell) icon and then click **Alert rules**.
1. Expand the `fundamentals > fundamentals` folder to view our created alert rule.
1. Click the **Edit** icon and scroll down to **Section 4**.
1. Click the **Edit** icon and scroll down to **Section 5**.
1. Click the **Link dashboard and panel** button and select the dashboard and panel to which you want the alert to be added as an annotation.
1. Click **Confirm** and **Save rule and exit** to save all the changes.
1. In Grafana's sidebar, navigate to the dashboard by clicking **Dashboards** and selecting the dashboard you created.