Skip to content

Commit

Permalink
Merge pull request #156 from grafana/update-generated-tutorials
Browse files Browse the repository at this point in the history
Update generated tutorials
  • Loading branch information
Jayclifford345 authored Oct 31, 2024
2 parents 7fee13b + e2617c8 commit 65ea11e
Show file tree
Hide file tree
Showing 19 changed files with 108 additions and 131 deletions.
12 changes: 6 additions & 6 deletions grafana/alerting-get-started/preprocessed.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ To demonstrate the observation of data using the Grafana stack, download and run

Besides being an open-source observability tool, Grafana has its own built-in alerting service. This means that you can receive notifications whenever there is an event of interest in your data, and even see these events graphed in your visualizations.

In this step, we set up a new contact point. This contact point will use the [webhook integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/). In order to make this work, we also need an endpoint for our webhook integration to receive the alert. We will use [Webhook.site](https://webhook.site/) to quickly set up that test endpoint. This way we can make sure that our alert is actually sending a notification somewhere.
In this step, we set up a new contact point. This contact point uses the [webhook integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/). In order to make this work, we also need an endpoint for our webhook integration to receive the alert. We can use [Webhook.site](https://webhook.site/) to quickly set up that test endpoint. This way we can make sure that our alert is actually sending a notification somewhere.

1. In your browser, **sign in** to your Grafana Cloud account.

Expand Down Expand Up @@ -173,7 +173,7 @@ Next, we establish an [alert rule](https://grafana.com/docs/grafana/latest/alert

1. In Grafana, **navigate to Alerting** > **Alert rules**. Click on **New alert rule**.

1. Enter alert rule name for your alert rule. Make it short and descriptive as this will appear in your alert notification. For instance, **database-metrics**
1. Enter alert rule name for your alert rule. Make it short and descriptive as this appears in your alert notification. For instance, **database-metrics**

### Define query and alert condition

Expand All @@ -187,7 +187,7 @@ In this section, we use the default options for Grafana-managed alert rule creat
vector(1)
```

In Prometheus, `vector(1)` is a special type of PromQL query that generates a constant vector. This is useful in testing and query manipulation, where you might need a constant value for calculations or comparisons. This query will allow you to create an alert rule that will be always firing.
In Prometheus, `vector(1)` is a special type of PromQL query that generates a constant vector. This is useful in testing and query manipulation, where you might need a constant value for calculations or comparisons. This query allows you to create an alert rule that is always firing.

1. In the **Alert condition** section:

Expand All @@ -209,9 +209,9 @@ The [alert rule evaluation](https://grafana.com/docs/grafana/latest/alerting/fun

To set up the evaluation:

1. In **Folder**, click **+ New folder** and enter a name. For example: _metric-alerts_. This folder will contain our alerts.
1. In the **Evaluation group**, repeat the above step to create a new evaluation group. We will name it _1m-evaluation_.
1. Choose an **Evaluation interval** (how often the alert will be evaluated).
1. In **Folder**, click **+ New folder** and enter a name. For example: _metric-alerts_. This folder contains our alerts.
1. In the **Evaluation group**, repeat the above step to create a new evaluation group. Name it _1m-evaluation_.
1. Choose an **Evaluation interval** (how often the alert are evaluated).
For example, every `1m` (1 minute).
1. Set the pending period to, `0s` (zero seconds), so the alert rule fires the moment the condition is met.

Expand Down
2 changes: 1 addition & 1 deletion grafana/alerting-get-started/step2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Besides being an open-source observability tool, Grafana has its own built-in alerting service. This means that you can receive notifications whenever there is an event of interest in your data, and even see these events graphed in your visualizations.

In this step, we set up a new contact point. This contact point will use the [webhook integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/). In order to make this work, we also need an endpoint for our webhook integration to receive the alert. We will use [Webhook.site](https://webhook.site/) to quickly set up that test endpoint. This way we can make sure that our alert is actually sending a notification somewhere.
In this step, we set up a new contact point. This contact point uses the [webhook integration](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/). In order to make this work, we also need an endpoint for our webhook integration to receive the alert. We can use [Webhook.site](https://webhook.site/) to quickly set up that test endpoint. This way we can make sure that our alert is actually sending a notification somewhere.

1. In your browser, **sign in** to your Grafana Cloud account.

Expand Down
10 changes: 5 additions & 5 deletions grafana/alerting-get-started/step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Next, we establish an [alert rule](https://grafana.com/docs/grafana/latest/alert

1. In Grafana, **navigate to Alerting** > **Alert rules**. Click on **New alert rule**.

1. Enter alert rule name for your alert rule. Make it short and descriptive as this will appear in your alert notification. For instance, **database-metrics**
1. Enter alert rule name for your alert rule. Make it short and descriptive as this appears in your alert notification. For instance, **database-metrics**

## Define query and alert condition

Expand All @@ -20,7 +20,7 @@ In this section, we use the default options for Grafana-managed alert rule creat
vector(1)
```{{copy}}
In Prometheus, `vector(1)`{{copy}} is a special type of PromQL query that generates a constant vector. This is useful in testing and query manipulation, where you might need a constant value for calculations or comparisons. This query will allow you to create an alert rule that will be always firing.
In Prometheus, `vector(1)`{{copy}} is a special type of PromQL query that generates a constant vector. This is useful in testing and query manipulation, where you might need a constant value for calculations or comparisons. This query allows you to create an alert rule that is always firing.
1. In the **Alert condition** section:
Expand All @@ -44,11 +44,11 @@ The [alert rule evaluation](https://grafana.com/docs/grafana/latest/alerting/fun
To set up the evaluation:
1. In **Folder**, click **+ New folder** and enter a name. For example: _metric-alerts_. This folder will contain our alerts.
1. In **Folder**, click **+ New folder** and enter a name. For example: _metric-alerts_. This folder contains our alerts.
1. In the **Evaluation group**, repeat the above step to create a new evaluation group. We will name it _1m-evaluation_.
1. In the **Evaluation group**, repeat the above step to create a new evaluation group. Name it _1m-evaluation_.
1. Choose an **Evaluation interval** (how often the alert will be evaluated).
1. Choose an **Evaluation interval** (how often the alert are evaluated).
For example, every `1m`{{copy}} (1 minute).
1. Set the pending period to, `0s`{{copy}} (zero seconds), so the alert rule fires the moment the condition is met.
Expand Down
2 changes: 1 addition & 1 deletion grafana/alerting-loki-logs/finish.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
> Check out our [advanced alerting tutorial](https://grafana.com/tutorials/alerting-get-started-pt2/) to explore advanced topics such as alert instances and notification routing.
> In [Get started with Grafana Alerting - Part 2](http://www.grafana.com/tutorials/alerting-get-started-pt2/) you can advance your skills by exploring alert instances and notification routing.
2 changes: 1 addition & 1 deletion grafana/alerting-loki-logs/index.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "How to create alerts with log data",
"title": "How to create alert rules with log data",
"description": "Learn how to use Loki with Grafana Alerting to keep track of what’s happening in your environment with real log data.",
"details": {
"intro": {
Expand Down
2 changes: 1 addition & 1 deletion grafana/alerting-loki-logs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ In this tutorial, you’ll:

- Create a Webhook contact point to send alert notifications to.

> Check out our [advanced alerting tutorial](https://grafana.com/tutorials/alerting-get-started-pt2/) to explore advanced topics such as alert instances and notification routing.
> In [Get started with Grafana Alerting - Part 2](http://www.grafana.com/tutorials/alerting-get-started-pt2/) you can advance your skills by exploring alert instances and notification routing.
Loading

0 comments on commit 65ea11e

Please sign in to comment.