XeLabs/awesome-prometheus-alerts
2
0
Fork 0
mirror of https://github.com/samber/awesome-prometheus-alerts.git synced 2026-06-25 02:46:59 +08:00
Code Issues Projects Releases Packages Wiki Activity

Improves readme and contributing guidelines

Browse source
This commit is contained in:
Samuel Berthe 2020-03-08 15:17:55 +01:00
parent 718a039313
commit 90a9a08b7c
No known key found for this signature in database
GPG key ID: 9D7813625412A946
2 changed files with 30 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
CONTRIBUTING.md
View file

@ -5,7 +5,18 @@
Rules are here: `_data/rules.yml`. Rules are here: `_data/rules.yml`.
## Run localy ### Guidelines
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Keep descriptions short and simple, but descriptive.
- Description must be factual (the "what?") and should provide root cause suggestions (the "why?"), for faster resolution.
- Queries must be tested on latest exporter version.
## Improving Github page
### Run localy
``` ```
gem install bundler gem install bundler
@ -24,11 +35,3 @@ Or with Docker-Compose:
``` ```
docker-compose up -d docker-compose up -d
``` ```
## Guidelines
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Keep descriptions short and simple, but descriptive.
- Queries must be tested on latest exporter version.

27
README.md
View file

@ -1,15 +1,18 @@
# Awesome Prometheus Alerts [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) # 👋 Awesome Prometheus Alerts [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)
> Most alerting rules are common to any Prometheus setup. We need a place to find them all. 🤘 🚨 📊 > Most alerting rules are common to any Prometheus setup. We need a place to find them all. 🤘 🚨 📊
Collection available here: **[https://awesome-prometheus-alerts.grep.to](https://awesome-prometheus-alerts.grep.to)** Collection available here: **[https://awesome-prometheus-alerts.grep.to](https://awesome-prometheus-alerts.grep.to)**
## Contents ## ✨ Contents
- [Rules](#rules) - [Rules](#rules)
- [Contributing](#-contributing)
- [Improvements](#improvements) - [Improvements](#improvements)
- [Help us](#-show-your-support)
- [License](#-license)
## Rules ## 🚨 Rules
- [Prometheus internals](https://awesome-prometheus-alerts.grep.to/rules#prometheus-internals) - [Prometheus internals](https://awesome-prometheus-alerts.grep.to/rules#prometheus-internals)
- [Host/Hardware](https://awesome-prometheus-alerts.grep.to/rules#host-and-hardware) - [Host/Hardware](https://awesome-prometheus-alerts.grep.to/rules#host-and-hardware)
@ -43,20 +46,26 @@ Collection available here: **[https://awesome-prometheus-alerts.grep.to](https:/
- [Minio](https://awesome-prometheus-alerts.grep.to/rules#minio) - [Minio](https://awesome-prometheus-alerts.grep.to/rules#minio)
- [CoreDNS](https://awesome-prometheus-alerts.grep.to/rules#coredns) - [CoreDNS](https://awesome-prometheus-alerts.grep.to/rules#coredns)
## Contributing ## 🤝 Contributing
Contributions for common alerting rules are most welcome! Contributions from community (you!) are most welcome!
For few months, many exporters have changed metric names, in order to follow community conventions. There are many ways to contribute: writing code, alerting rules, documentation, reporting issues, discussing better error tracking...
Please create an issue or a small pull-request with corrected metric name. 🙏
[Instructions here](CONTRIBUTING.md) [Instructions here](CONTRIBUTING.md)
## Improvements ## 🏋️ Improvements
- Create an alert rule builder in Jekyll for custom alerts (severity, thresholds, instances...) - Create an alert rule builder in Jekyll for custom alerts (severity, thresholds, instances...)
- Add resolution suggestions to rule descriptions, for faster incident resolution ([#85](https://github.com/samber/awesome-prometheus-alerts/issues/85)).
## License ## 💫 Show your support
Give a ⭐️ if this project helped you!
[![support us](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/samber)
## 📝 License
[![CC4](https://mirrors.creativecommons.org/presskit/cc.srr.primary.svg)](https://creativecommons.org/licenses/by/4.0/legalcode) [![CC4](https://mirrors.creativecommons.org/presskit/cc.srr.primary.svg)](https://creativecommons.org/licenses/by/4.0/legalcode)