centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix and tidy alertmanager heartbeat template (#1865)

Browse source 
# What this PR does


There was an unnecessary indentation in the `rules:` key which made it
invalid YAML.

Also replaced the mentions to Amixr with Grafana OnCall, used some
`<code>` tags and reworded some sentences.

Also removed the anchor tag from the webhook link: we don't want people
to follow that in their browser, we want them to copy it

## Result screenshot


![image](https://user-images.githubusercontent.com/1511481/236173565-b5201b81-4d69-4d0b-944a-a2106f8fbab3.png)

## Which issue(s) this PR fixes

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)

---------

Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
This commit is contained in:
Oleg Zaytsev 2023-05-05 02:25:05 +02:00 • committed by GitHub
parent 620f69e409
commit 41f7c23c65
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
engine/apps/integrations/templates/heartbeat_instructions/alertmanager.html
View file

@ -1,25 +1,25 @@
<p>This configuration will send an alert once in a minute and if alertmanager stops working amixr will detect that it
doesn't work and notify you about that.</p>
<p>This configuration will send an alert once a minute, and if alertmanager stops working, OnCall will detect
it and notify you about that.</p>
<ol>
<li>Add the alert generating script to prometheus.yaml file
Within prometheus it is trivial to create an expression that we can build a heartbeat with Amixr
expr: vector(1)
<p>That expression will always return true. Here is an alert that leverages the previous expression to create a
heartbeat alert</p>
<li>
<p>Add the alert generating script to <code>prometheus.yaml</code> file.
Within Prometheus it is trivial to create an expression that we can use as a heartbeat for OnCall,
like <code>vector(1)</code>. That expression will always return true.</p>
<p>Here is an alert that leverages the previous expression to create a heartbeat alert:</p>
<pre><code>
groups:
- name: meta
rules:
- alert: heartbeat
expr: vector(1)
labels:
severity: none
annotations:
description: This is heartbeat alert
summary: Alerting Amixr
rules:
- alert: heartbeat
expr: vector(1)
labels:
severity: none
annotations:
description: This is a heartbeat alert for Grafana OnCall
summary: Heartbeat for Grafana OnCall
</code></pre>
</li>
<li>Add receiver configuration to prometheus.yaml with the unique url from Amixr global
<li><p>Add receiver configuration to <code>prometheus.yaml</code> with the unique url from OnCall global:</p>
<pre><code>
...
route:
@ -27,12 +27,12 @@
routes:
- match:
alertname: heartbeat
receiver: 'amixr-heartbeat'
receiver: 'grafana-oncall-heartbeat'
group_wait: 0s
group_interval: 1m
repeat_interval: 50s
receivers:
- name: 'amixr-heartbeat'
- name: 'grafana-oncall-heartbeat'
webhook_configs:
- url: {{ heartbeat_url }}
send_resolved: false

10
grafana-plugin/src/containers/HeartbeatModal/HeartbeatForm.tsx
View file

@ -105,12 +105,10 @@ const HeartbeatForm = observer(({ alertReceveChannelId, onUpdate }: HeartBeatMod
</p>
{heartbeat && (
<p>
<Text>
Use the following unique Grafana link to send GET and POST requests:{' '}
<a href={heartbeat?.link} target="_blank" rel="noreferrer">
{heartbeat?.link}
</a>
</Text>
<Text>Use the following unique Grafana link to send GET and POST requests:</Text>
<pre>
<code>{heartbeat?.link}</code>
</pre>
</p>
)}
{heartbeat && (