mirror of
https://github.com/zulip/zulip.git
synced 2025-11-07 15:33:30 +00:00
977a043d03
This commit adds support for Grafana's new alerting system, Grafana Alerting. The existing Grafana integration has been modified to detect the version of the notification through the structure of the payload body, since the the structure varies by version. Support for legacy alerting is been continued. Example fixtures have been added for Grafana Alerting's webhooks. Tests updated.
213 lines
5.6 KiB
Python
213 lines
5.6 KiB
Python
from zerver.lib.test_classes import WebhookTestCase
|
|
|
|
|
|
class GrafanaHookTests(WebhookTestCase):
|
|
STREAM_NAME = "grafana"
|
|
URL_TEMPLATE = "/api/v1/external/grafana?&api_key={api_key}&stream={stream}"
|
|
WEBHOOK_DIR_NAME = "grafana"
|
|
|
|
# Note: Include a test function per each distinct message condition your integration supports
|
|
def test_alert(self) -> None:
|
|
expected_topic = "[Alerting] Test notification"
|
|
expected_message = """
|
|
:alert: **ALERTING**
|
|
|
|
[Test rule](http://localhost:3000/)
|
|
|
|
Someone is testing the alert notification within grafana.
|
|
|
|
**High value:** 100
|
|
**Higher Value:** 200
|
|
|
|
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"alert",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_no_data_alert(self) -> None:
|
|
expected_topic = "[Alerting] No Data alert"
|
|
expected_message = """
|
|
:alert: **ALERTING**
|
|
|
|
[No Data alert](http://localhost:3000/d/GG2qhR3Wz/alerttest?fullscreen&edit&tab=alert&panelId=6&orgId=1)
|
|
|
|
The panel has no data.
|
|
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"no_data_alert",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_no_message_alert(self) -> None:
|
|
expected_topic = "[Alerting] No Message alert"
|
|
expected_message = """
|
|
:alert: **ALERTING**
|
|
|
|
[No Message alert](http://localhost:3000/d/GG2qhR3Wz/alerttest?fullscreen&edit&tab=alert&panelId=8&orgId=1)
|
|
|
|
**A-series:** 21.573108436586445
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"no_message_alert",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
# Note: Include a test function per each distinct message condition your integration supports
|
|
def test_alert_ok(self) -> None:
|
|
expected_topic = "[Ok] Test notification"
|
|
expected_message = """
|
|
:squared_ok: **OK**
|
|
|
|
[Test rule](http://localhost:3000/)
|
|
|
|
Someone is testing the alert notification within grafana.
|
|
|
|
**High value:** 0
|
|
|
|
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"alert_ok",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
# Note: Include a test function per each distinct message condition your integration supports
|
|
def test_alert_paused(self) -> None:
|
|
expected_topic = "[Paused] Test notification"
|
|
expected_message = """
|
|
:info: **PAUSED**
|
|
|
|
[Test rule](http://localhost:3000/)
|
|
|
|
Someone is testing the alert notification within grafana.
|
|
|
|
|
|
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"alert_paused",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
# Note: Include a test function per each distinct message condition your integration supports
|
|
def test_alert_pending(self) -> None:
|
|
expected_topic = "[Pending] Test notification"
|
|
expected_message = """
|
|
:info: **PENDING**
|
|
|
|
[Test rule](http://localhost:3000/)
|
|
|
|
Someone is testing the alert notification within grafana.
|
|
|
|
**High value:** 100
|
|
**Higher Value:** 200
|
|
|
|
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
|
|
""".strip()
|
|
|
|
# use fixture named helloworld_hello
|
|
self.check_webhook(
|
|
"alert_pending",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_alert_new(self) -> None:
|
|
expected_topic = "[RESOLVED:1]"
|
|
expected_message = """
|
|
:checkbox: **RESOLVED**
|
|
|
|
Webhook test message.
|
|
|
|
---
|
|
**Alert 1**: TestAlert.
|
|
|
|
This alert was fired at <time:2022-08-31T05:54:04.52289368Z>.
|
|
|
|
This alert was resolved at <time:2022-08-31T10:30:00.52288431Z>.
|
|
|
|
Labels:
|
|
- alertname: TestAlert
|
|
- instance: Grafana
|
|
|
|
Annotations:
|
|
- summary: Notification test
|
|
|
|
1 alert(s) truncated.
|
|
""".strip()
|
|
|
|
self.check_webhook(
|
|
"alert_new",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_alert_new_multiple(self) -> None:
|
|
expected_topic = "[FIRING:2]"
|
|
expected_message = """
|
|
:alert: **FIRING**
|
|
|
|
Webhook test message.
|
|
|
|
---
|
|
**Alert 1**: High memory usage.
|
|
|
|
This alert was fired at <time:2021-10-12T09:51:03.157076+02:00>.
|
|
Labels:
|
|
- alertname: High memory usage
|
|
- team: blue
|
|
- zone: us-1
|
|
|
|
Annotations:
|
|
- description: The system has high memory usage
|
|
- runbook_url: https://myrunbook.com/runbook/1234
|
|
- summary: This alert was triggered for zone us-1
|
|
|
|
|
|
---
|
|
**Alert 2**: High CPU usage.
|
|
|
|
This alert was fired at <time:2021-10-12T09:56:03.157076+02:00>.
|
|
Labels:
|
|
- alertname: High CPU usage
|
|
- team: blue
|
|
- zone: eu-1
|
|
|
|
Annotations:
|
|
- description: The system has high CPU usage
|
|
- runbook_url: https://myrunbook.com/runbook/1234
|
|
- summary: This alert was triggered for zone eu-1
|
|
""".strip()
|
|
|
|
self.check_webhook(
|
|
"alert_new_multiple",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|