diff --git a/content/docs/tutorials/alerting_based_on_metrics.md b/content/docs/tutorials/alerting_based_on_metrics.md index 5d7335b1c..e56ca3f39 100644 --- a/content/docs/tutorials/alerting_based_on_metrics.md +++ b/content/docs/tutorials/alerting_based_on_metrics.md @@ -1,5 +1,5 @@ --- -title: Alerting based on metrics. +title: Alerting based on metrics sort_rank: 5 --- @@ -8,13 +8,13 @@ sort_rank: 5 In this tutorial we will create alerts on the `ping_request_count` metric that we instrumented earlier in the [Instrumenting HTTP server written in Go](../instrumenting_http_server_in_go/) tutorial. -For the sake of this tutorial we will alert when the `ping_request_count` metric is greater than 5, Checkout real world [best practices](../../practices/alerting) to learn more about alerting principles. +For the sake of this tutorial we will alert when the `ping_request_count` metric is greater than 5. Check out real world [best practices](../../practices/alerting) to learn more about alerting principles. -Download the latest release of Alertmanager for your operating system from [here](https://github.com/prometheus/alertmanager/releases) +Download the latest release of Alertmanager for your operating system from [here](https://github.com/prometheus/alertmanager/releases). Alertmanager supports various receivers like `email`, `webhook`, `pagerduty`, `slack` etc through which it can notify when an alert is firing. You can find the list of receivers and how to configure them [here](../../alerting/latest/configuration). We will use `webhook` as a receiver for this tutorial, head over to [webhook.site](https://webhook.site) and copy the webhook URL which we will use later to configure the Alertmanager. -First let's setup Alertmanager with webhook receiver. +First let's setup Alertmanager with the webhook receiver. > alertmanager.yml @@ -61,7 +61,7 @@ scrape_configs: - targets: ["localhost:8090"] ``` -If you notice the `evaluation_interval`,`rule_files` and `alerting` sections are added to the Prometheus config, the `evaluation_interval` defines the intervals at which the rules are evaluated, `rule_files` accepts an array of yaml files that defines the rules and the `alerting` section defines the Alertmanager configuration. As mentioned in the beginning of this tutorial we will create a basic rule where we want to +Note that the `evaluation_interval`,`rule_files` and `alerting` sections were added to the Prometheus config. `evaluation_interval` defines the intervals at which the rules are evaluated, `rule_files` accepts an array of yaml files that defines the rules and the `alerting` section defines the Alertmanager configuration. As mentioned in the beginning of this tutorial we will create a basic rule where we want to raise an alert when the `ping_request_count` value is greater than 5. > rules.yml @@ -79,7 +79,7 @@ Now let's run Prometheus using the following command. `prometheus --config.file=./prometheus.yml` -Open [http://localhost:9090/rules](http://localhost:9090/rules) in your browser to see the rules. Next run the instrumented ping server and visit the [http://localhost:8090/ping](http://localhost:8090/ping) endpoint and refresh the page atleast 6 times. You can check the ping count by navigating to [http://localhost:8090/metrics](http://localhost:8090/metrics) endpoint. To see the status of the alert visit [http://localhost:9090/alerts](http://localhost:9090/alerts). Once the condition `ping_request_count > 5` is true for more than 10s the `state` will become `FIRING`. Now if you navigate back to your `webhook.site` URL you will see the alert message. +Open [http://localhost:9090/rules](http://localhost:9090/rules) in your browser to see the rules. Next run the instrumented ping server and visit the [http://localhost:8090/ping](http://localhost:8090/ping) endpoint and refresh the page at least 6 times. You can check the ping count by navigating to the [http://localhost:8090/metrics](http://localhost:8090/metrics) endpoint. To see the status of the alert visit [http://localhost:9090/alerts](http://localhost:9090/alerts). Once the condition `ping_request_count > 5` is true for more than 10s the `state` will become `FIRING`. Now if you navigate back to your `webhook.site` URL you will see the alert message.