Skip to content

Commit d582567

Browse files
authored
Merge pull request #221 from grafana/update-generated-tutorials
2 parents e4313b6 + c9e0744 commit d582567

File tree

19 files changed

+57
-42
lines changed

19 files changed

+57
-42
lines changed

grafana/alerting-get-started-pt2/index.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "Get started with Grafana Alerting - Part 2 of 4",
2+
"title": "Get started with Grafana Alerting - Part 2",
33
"description": "Learn to use alert instances and route notifications by labels to contacts, building on your alerting skills in Grafana for more advanced workflows — Part 2.",
44
"details": {
55
"intro": {

grafana/alerting-get-started-pt2/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get started with Grafana Alerting - Part 2 of 4
1+
# Get started with Grafana Alerting - Part 2
22

33
The Get started with Grafana Alerting tutorial Part 2 is a continuation of [Get started with Grafana Alerting tutorial Part 1](http://www.grafana.com/tutorials/alerting-get-started/).
44

grafana/alerting-get-started-pt2/preprocessed.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ labels:
1010
- cloud
1111
tags:
1212
- beginner
13-
title: Get started with Grafana Alerting - Part 2 of 4
13+
title: Get started with Grafana Alerting - Part 2
1414
weight: 50
1515
killercoda:
16-
title: Get started with Grafana Alerting - Part 2 of 4
16+
title: Get started with Grafana Alerting - Part 2
1717
description: Learn to use alert instances and route notifications by labels to contacts, building on your alerting skills in Grafana for more advanced workflows — Part 2.
1818
backend:
1919
imageid: ubuntu
2020
---
2121

2222
<!-- INTERACTIVE page intro.md START -->
2323

24-
# Get started with Grafana Alerting - Part 2 of 4
24+
# Get started with Grafana Alerting - Part 2
2525

2626
The Get started with Grafana Alerting tutorial Part 2 is a continuation of [Get started with Grafana Alerting tutorial Part 1](http://www.grafana.com/tutorials/alerting-get-started/).
2727

@@ -180,7 +180,7 @@ Create a notification policy if you want to handle metrics returned by alert rul
180180

181181
This new child policy routes alerts that match the label `device=desktop` to the Webhook contact point.
182182

183-
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#list-of-supported-integrations).
183+
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#supported-contact-point-integrations).
184184

185185
<!-- INTERACTIVE ignore END -->
186186

@@ -197,7 +197,7 @@ Create a notification policy if you want to handle metrics returned by alert rul
197197

198198
This new child policy routes alerts that match the label `device=desktop` to the Webhook contact point.
199199

200-
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#list-of-supported-integrations).
200+
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#supported-contact-point-integrations).
201201

202202

203203
<!-- INTERACTIVE page step4.md END -->

grafana/alerting-get-started-pt2/step4.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Create a notification policy if you want to handle metrics returned by alert rul
1818

1919
This new child policy routes alerts that match the label `device=desktop`{{copy}} to the Webhook contact point.
2020

21-
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`{{copy}}. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#list-of-supported-integrations).
21+
1. **Repeat the steps above to create a second child policy** to match another alert instance. For labels use: `device=mobile`{{copy}}. Use the Webhook integration for the contact point. Alternatively, experiment by using a different Webhook endpoint or a [different integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#supported-contact-point-integrations).

grafana/alerting-get-started-pt3/index.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "Get started with Grafana Alerting - Part 3 of 4",
2+
"title": "Get started with Grafana Alerting - Part 3",
33
"description": "Learn how to group alert notifications effectively to reduce noise and streamline communication in Grafana Alerting — Part 3.",
44
"details": {
55
"intro": {

grafana/alerting-get-started-pt3/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get started with Grafana Alerting - Part 3 of 4
1+
# Get started with Grafana Alerting - Part 3
22

33
The Get started with Grafana Alerting tutorial Part 3 is a continuation of [Get started with Grafana Alerting tutorial Part 2](http://www.grafana.com/tutorials/alerting-get-started-pt2/).
44

grafana/alerting-get-started-pt3/preprocessed.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ labels:
1010
- cloud
1111
tags:
1212
- intermediate
13-
title: Get started with Grafana Alerting - Part 3 of 4
13+
title: Get started with Grafana Alerting - Part 3
1414
weight: 60
1515
killercoda:
16-
title: Get started with Grafana Alerting - Part 3 of 4
16+
title: Get started with Grafana Alerting - Part 3
1717
description: Learn how to group alert notifications effectively to reduce noise and streamline communication in Grafana Alerting — Part 3.
1818
backend:
1919
imageid: ubuntu
@@ -37,7 +37,7 @@ refs:
3737

3838
<!-- INTERACTIVE page intro.md START -->
3939

40-
# Get started with Grafana Alerting - Part 3 of 4
40+
# Get started with Grafana Alerting - Part 3
4141

4242
The Get started with Grafana Alerting tutorial Part 3 is a continuation of [Get started with Grafana Alerting tutorial Part 2](http://www.grafana.com/tutorials/alerting-get-started-pt2/).
4343

grafana/alerting-get-started-pt4/finish.md

+4
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ To deepen your understanding of Grafana’s templating, explore the following re
1313
- [**Notification template reference**](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/reference/): Lists the data available for use in notification templates and explores specific functions.
1414

1515
- [**Alert rule template reference**](https://grafana.com/docs/grafana/latest/alerting/alerting-rules/templates/reference/): Covers the specifics of creating dynamic labels and annotations for alert rules using elements such as variables and functions.
16+
17+
# Learn more in [Grafana Alerting Part 5](http://www.grafana.com/tutorials/alerting-get-started-pt5/)
18+
19+
In [Get started with Grafana Alerting - Part 5](http://www.grafana.com/tutorials/alerting-get-started-pt5/) you learn how to dynamically route alerts and link them to dashboards.

grafana/alerting-get-started-pt4/preprocessed.md

+13
Original file line numberDiff line numberDiff line change
@@ -410,4 +410,17 @@ To deepen your understanding of Grafana’s templating, explore the following re
410410
- [**Notification template reference**](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/reference/): Lists the data available for use in notification templates and explores specific functions.
411411
- [**Alert rule template reference**](https://grafana.com/docs/grafana/latest/alerting/alerting-rules/templates/reference/): Covers the specifics of creating dynamic labels and annotations for alert rules using elements such as variables and functions.
412412
413+
## Learn more in [Grafana Alerting Part 5](http://www.grafana.com/tutorials/alerting-get-started-pt5/)
414+
415+
<!-- INTERACTIVE ignore START -->
416+
417+
> **Tip:**
418+
> In [Get started with Grafana Alerting - Part 5](http://www.grafana.com/tutorials/alerting-get-started-pt5/) you learn how to dynamically route alerts and link them to dashboards.
419+
420+
<!-- INTERACTIVE ignore END -->
421+
422+
423+
In [Get started with Grafana Alerting - Part 5](http://www.grafana.com/tutorials/alerting-get-started-pt5/) you learn how to dynamically route alerts and link them to dashboards.
424+
425+
413426
<!-- INTERACTIVE page finish.md END -->

grafana/alerting-get-started-pt5/index.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"title": "Get started with Grafana Alerting - Part 5",
3-
"description": "Learn how to dinamically route alerts and link them to dashboards — Part 5.",
3+
"description": "Learn how to dynamically route alerts and link them to dashboards — Part 5.",
44
"details": {
55
"intro": {
66
"text": "intro.md"

grafana/alerting-get-started-pt5/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ In this tutorial you will learn how to:
66

77
- Leverage notification policies for **dynamic routing based on query values**: Use notification policies to route alerts based on dynamically generated labels, in a way that critical alerts reach the on-call team and less urgent ones go to a general monitoring channel.
88

9-
- Set **mute timings** to suppress certain alerts during maintenance, or weekends.
9+
- Set **mute timings** to suppress certain alerts during maintenance or weekends.
1010

1111
- **Link alerts to dashboards** to provide more context to resolve issues.

grafana/alerting-get-started-pt5/preprocessed.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Feedback Link: https://github.com/grafana/tutorials/issues/new
33
categories:
44
- alerting
5-
description: Learn how to dinamically route alerts and link them to dashboards — Part 5.
5+
description: Learn how to dynamically route alerts and link them to dashboards — Part 5.
66
labels:
77
products:
88
- enterprise
@@ -14,7 +14,7 @@ title: Get started with Grafana Alerting - Part 5
1414
weight: 60
1515
killercoda:
1616
title: Get started with Grafana Alerting - Part 5
17-
description: Learn how to dinamically route alerts and link them to dashboards — Part 5.
17+
description: Learn how to dynamically route alerts and link them to dashboards — Part 5.
1818
backend:
1919
imageid: ubuntu
2020
---
@@ -30,7 +30,7 @@ In this tutorial, we focus on optimizing your alerting strategy using Grafana fo
3030
In this tutorial you will learn how to:
3131

3232
- Leverage notification policies for **dynamic routing based on query values**: Use notification policies to route alerts based on dynamically generated labels, in a way that critical alerts reach the on-call team and less urgent ones go to a general monitoring channel.
33-
- Set **mute timings** to suppress certain alerts during maintenance, or weekends.
33+
- Set **mute timings** to suppress certain alerts during maintenance or weekends.
3434
- **Link alerts to dashboards** to provide more context to resolve issues.
3535

3636
<!-- INTERACTIVE page intro.md END -->
@@ -53,7 +53,7 @@ In this tutorial you will learn how to:
5353

5454
### Set up the Grafana stack
5555

56-
To demonstrate the observation of data using the Grafana stack, download and run the following files.
56+
To observe data using the Grafana stack, download and run the following files.
5757

5858
1. Clone the [tutorial environment repository](https://github.com/tonypowa/grafana-prometheus-alerting-demo.git).
5959

@@ -87,7 +87,6 @@ To demonstrate the observation of data using the Grafana stack, download and run
8787
<!-- INTERACTIVE exec END -->
8888

8989

90-
9190
1. Bring up the containers:
9291

9392
<!-- INTERACTIVE ignore START -->
@@ -108,7 +107,6 @@ To demonstrate the observation of data using the Grafana stack, download and run
108107
<!-- INTERACTIVE exec END -->
109108

110109

111-
112110
The first time you run `docker compose up -d`, Docker downloads all the necessary resources for the tutorial. This might take a few minutes, depending on your internet connection.
113111

114112
<!-- INTERACTIVE ignore START -->
@@ -175,7 +173,7 @@ The time-series visualization supports alert rules to provide more context in th
175173

176174
- In the query area, copy and paste the following PromQL query:
177175

178-
** switch to **Code** mode if not already selected **
176+
** switch to **Code** mode if not already selected **
179177

180178
```promql
181179
flask_app_cpu_usage{environment="prod"}
@@ -194,9 +192,9 @@ The time-series visualization supports alert rules to provide more context in th
194192
flask_app_memory_usage{environment="prod"}
195193
```
196194
197-
{{< figure src="/media/docs/alerting/time-series_cpu_mem_usage_metrics.png" max-width="1200px" caption="Time-series panel displaying CPU and memory usage metrics in production." >}}
195+
{{< figure src="/media/docs/alerting/time-series_cpu_mem_usage_metrics.png" max-width="1200px" caption="Time-series panel displaying CPU and memory usage metrics in production." >}}
198196
199-
Both metrics return labels that we’ll use later to link alert instances with the appropriate routing. These labels help define how alerts are routed based on their environment or other criteria.
197+
Both metrics return labels that we’ll use later to link alert instances with the appropriate routing. These labels help define how alerts are routed based on their environment or other criteria.
200198
201199
1. Click **Save dashboard**.
202200
@@ -247,11 +245,11 @@ Follow these steps to manually create alert rules and link them to a visualizati
247245
## Create an alert rule for CPU usage
248246
249247
1. Navigate to **Alerts & IRM > Alerting > Alert rules** from the Grafana sidebar.
250-
1. Click **+ New alert** rule to create a new alert.
248+
1. Click **+ New alert rule** rule to create a new alert.
251249
252250
### Enter alert rule name
253251
254-
Make it short and descriptive as this will appear in your alert notification. For instance, `CPU usage` .
252+
Make it short and descriptive, as this will appear in your alert notification. For instance, `CPU usage` .
255253
256254
### Define query and alert condition
257255
@@ -349,7 +347,7 @@ Now that we've set up notification policies, we can demonstrate how to mute aler
349347
Mute timings are useful for suppressing alerts with certain labels during maintenance windows or weekends.
350348

351349
1. Navigate to **Alerts & IRM > Alerting > Notification Policies**.
352-
- Enter a name. E.g., `Planned downtime` , or `Non-business hours`.
350+
- Enter a name, e.g. `Planned downtime` or `Non-business hours`.
353351
- Select **Sat** and **Sun**, to apply the mute timing to all Saturdays and Sundays.
354352
- Click **Save mute timing**.
355353
1. Add mute timing to the desired policy:

grafana/alerting-get-started-pt5/step1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Set up the Grafana stack
22

3-
To demonstrate the observation of data using the Grafana stack, download and run the following files.
3+
To observe data using the Grafana stack, download and run the following files.
44

55
1. Clone the [tutorial environment repository](https://github.com/tonypowa/grafana-prometheus-alerting-demo.git).
66

grafana/alerting-get-started-pt5/step3.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ The time-series visualization supports alert rules to provide more context in th
2828

2929
- In the query area, copy and paste the following PromQL query:
3030

31-
** switch to **Code** mode if not already selected **
31+
** switch to **Code** mode if not already selected **
3232

33-
```promql
34-
flask_app_cpu_usage{environment="prod"}
35-
```{{copy}}
33+
```promql
34+
flask_app_cpu_usage{environment="prod"}
35+
```{{copy}}
3636
3737
- Click **Run queries**.
3838
@@ -48,9 +48,9 @@ The time-series visualization supports alert rules to provide more context in th
4848
flask_app_memory_usage{environment="prod"}
4949
```{{copy}}
5050
51-
![Time-series panel displaying CPU and memory usage metrics in production.](https://grafana.com/media/docs/alerting/time-series_cpu_mem_usage_metrics.png)
51+
![Time-series panel displaying CPU and memory usage metrics in production.](https://grafana.com/media/docs/alerting/time-series_cpu_mem_usage_metrics.png)
5252
53-
Both metrics return labels that we’ll use later to link alert instances with the appropriate routing. These labels help define how alerts are routed based on their environment or other criteria.
53+
Both metrics return labels that we’ll use later to link alert instances with the appropriate routing. These labels help define how alerts are routed based on their environment or other criteria.
5454
5555
1. Click **Save dashboard**.
5656

grafana/alerting-get-started-pt5/step5.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Follow these steps to manually create alert rules and link them to a visualizati
66

77
1. Navigate to **Alerts & IRM > Alerting > Alert rules** from the Grafana sidebar.
88

9-
1. Click **+ New alert** rule to create a new alert.
9+
1. Click **+ New alert rule** rule to create a new alert.
1010

1111
## Enter alert rule name
1212

13-
Make it short and descriptive as this will appear in your alert notification. For instance, `CPU usage`{{copy}} .
13+
Make it short and descriptive, as this will appear in your alert notification. For instance, `CPU usage`{{copy}} .
1414

1515
## Define query and alert condition
1616

grafana/alerting-get-started-pt5/step7.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Now that we’ve set up notification policies, we can demonstrate how to mute al
55
Mute timings are useful for suppressing alerts with certain labels during maintenance windows or weekends.
66

77
1. Navigate to **Alerts & IRM > Alerting > Notification Policies**.
8-
- Enter a name. E.g., `Planned downtime`{{copy}} , or `Non-business hours`{{copy}}.
8+
- Enter a name, e.g. `Planned downtime`{{copy}} or `Non-business hours`{{copy}}.
99

1010
- Select **Sat** and **Sun**, to apply the mute timing to all Saturdays and Sundays.
1111

grafana/alerting-get-started/index.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "Get started with Grafana Alerting - Part 1 of 4",
2+
"title": "Get started with Grafana Alerting - Part 1",
33
"description": "Get started with Grafana Alerting by creating your first alert rule, sending notifications to a webhook, and generating data to test it live — Part 1.",
44
"details": {
55
"intro": {

grafana/alerting-get-started/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get started with Grafana Alerting - Part 1 of 4
1+
# Get started with Grafana Alerting - Part 1
22

33
In this guide, we walk you through the process of setting up your first alert in just a few minutes. You’ll witness your alert in action with real-time data, as well as sending alert notifications.
44

grafana/alerting-get-started/preprocessed.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ labels:
1111
- cloud
1212
tags:
1313
- beginner
14-
title: Get started with Grafana Alerting - Part 1 of 4
14+
title: Get started with Grafana Alerting - Part 1
1515
weight: 50
1616
killercoda:
17-
title: Get started with Grafana Alerting - Part 1 of 4
17+
title: Get started with Grafana Alerting - Part 1
1818
description: Get started with Grafana Alerting by creating your first alert rule, sending notifications to a webhook, and generating data to test it live — Part 1.
1919
backend:
2020
imageid: ubuntu
2121
---
2222

2323
<!-- INTERACTIVE page intro.md START -->
2424

25-
# Get started with Grafana Alerting - Part 1 of 4
25+
# Get started with Grafana Alerting - Part 1
2626

2727
In this guide, we walk you through the process of setting up your first alert in just a few minutes. You'll witness your alert in action with real-time data, as well as sending alert notifications.
2828

0 commit comments

Comments
 (0)