feat: add support for exporter-level comments (#481)

This commit is contained in:
Samuel Berthe 2025-11-05 17:04:30 +01:00 committed by GitHub
parent ae8cfb0366
commit 6e2db98590
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions

6
dist/template.yml vendored
View file

@ -2,9 +2,13 @@ groups:
{% assign groupName = slug | split: '-' %}{% capture groupNameCamelcase %}{% for word in groupName %}{{ word | capitalize }} {% endfor %}{% endcapture %}
- name: {{ groupNameCamelcase | remove: ' ' | remove: '-' }}
{% assign lines = comments | split: "
" %}{% for line in lines %}# {{ line | strip }}
{% endfor %}
rules:
{% for rule in rules %}{% assign ruleName = rule.name | split: ' ' %}{% capture ruleNameCamelcase %}{% for word in ruleName %}{{ word | capitalize }} {% endfor %}{% endcapture %}
{% for comment in comments %}# {{ comment | strip }}
{% assign lines = rule.comments | split: "
" %}{% for line in lines %}# {{ line | strip }}
{% endfor %}- alert: {{ ruleNameCamelcase | remove: ' ' }}
expr: '{{ rule.query }}'
for: {% if rule.for %}{{ rule.for }}{% else %}0m{% endif %}

View file

@ -62,6 +62,7 @@
// @TODO: Please contribute => https://github.com/samber/awesome-prometheus-alerts 👋
{% endhighlight %}
{% else %}
{{ exporter.comments | strip | newline_to_br }}
{% highlight bash %}
$ wget https://raw.githubusercontent.com/samber/awesome-prometheus-alerts/master/dist/rules/{{ service.name | replace: " ", "-" | downcase }}/{{ exporter.slug }}.yml
{% endhighlight %}