From 8973a90049b866c67c5652354f7450c7dba02215 Mon Sep 17 00:00:00 2001
From: Damien Grisonnet <dgrisonn@redhat.com>
Date: Thu, 25 Mar 2021 18:09:42 +0100
Subject: [PATCH] examples: use ExampleAlert instead of Watchdog
Replace Watchdog alerts part of the `example-group` in some examples by
ExampleAlert alerts to reinforce the fact that this is just an example.
Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>
---
docs/developing-prometheus-rules-and-grafana-dashboards.md | 6 +++---
examples/existingrule.json | 2 +-
examples/existingrule.yaml | 6 +++---
examples/prometheus-additional-alert-rule-example.jsonnet | 6 +++---
4 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/developing-prometheus-rules-and-grafana-dashboards.md b/docs/developing-prometheus-rules-and-grafana-dashboards.md
index 990c07bf..b3a67f1f 100644
--- a/docs/developing-prometheus-rules-and-grafana-dashboards.md
+++ b/docs/developing-prometheus-rules-and-grafana-dashboards.md
@@ -90,13 +90,13 @@ local kp = (import 'kube-prometheus/main.libsonnet') + {
name: 'example-group',
rules: [
{
- alert: 'Watchdog',
+ alert: 'ExampleAlert',
expr: 'vector(1)',
labels: {
- severity: 'none',
+ severity: 'warning',
},
annotations: {
- description: 'This is a Watchdog meant to ensure that the entire alerting pipeline is functional.',
+ description: 'This is an example alert.',
},
},
],
diff --git a/examples/existingrule.json b/examples/existingrule.json
index 41d6620b..8486eb7d 100644
--- a/examples/existingrule.json
+++ b/examples/existingrule.json
@@ -1 +1 @@
-{"groups":[{"name":"example-group","rules":[{"alert":"Watchdog","annotations":{"description":"This is a Watchdog meant to ensure that the entire alerting pipeline is functional."},"expr":"vector(1)","labels":{"severity":"none"}}]}]}
\ No newline at end of file
+{"groups":[{"name":"example-group","rules":[{"alert":"ExampleAlert","annotations":{"description":"This is an example alert."},"expr":"vector(1)","labels":{"severity":"warning"}}]}]}
\ No newline at end of file
diff --git a/examples/existingrule.yaml b/examples/existingrule.yaml
index 6a67032f..ab5de270 100644
--- a/examples/existingrule.yaml
+++ b/examples/existingrule.yaml
@@ -1,9 +1,9 @@
groups:
- name: example-group
rules:
- - alert: Watchdog
+ - alert: ExampleAlert
expr: vector(1)
labels:
- severity: "none"
+ severity: "warning"
annotations:
- description: This is a Watchdog meant to ensure that the entire alerting pipeline is functional.
+ description: This is an example alert.
diff --git a/examples/prometheus-additional-alert-rule-example.jsonnet b/examples/prometheus-additional-alert-rule-example.jsonnet
index 483b9cb1..43dc538c 100644
--- a/examples/prometheus-additional-alert-rule-example.jsonnet
+++ b/examples/prometheus-additional-alert-rule-example.jsonnet
@@ -18,13 +18,13 @@ local kp = (import 'kube-prometheus/main.libsonnet') + {
name: 'example-group',
rules: [
{
- alert: 'Watchdog',
+ alert: 'ExampleAlert',
expr: 'vector(1)',
labels: {
- severity: 'none',
+ severity: 'warning',
},
annotations: {
- description: 'This is a Watchdog meant to ensure that the entire alerting pipeline is functional.',
+ description: 'This is an example alert.',
},
},
],
--
GitLab