PARS

Overview 🧧

As the name suggests, PARS (Prometheus Alert Routing Simulation) is a tool used to simulate Prometheus alerts. This is built using JavaFx as a Desktop application and runs on wide variety of systems like Windows, macOS and Linux Operating systems.

Prometheus Overview

• Alertmanager handles alerts sent by client applications such as Prometheus server. The Alertmanager configuration consists of the Receivers and Routes definitions.
• Receivers are various notification integrations like Slack, Pagerduty, Email, Webhooks etc. that receive notifications when an alert is triggered.
• Routes map the alerts to corresponding receivers based on key-value attributes called MatcherConditions.
• Alerts are defined in Thanos rule files with key-value attributes called Labels. These labels must match with the MatcherConditions to reach the correct receiver. If the labels do not match with any of the MatcherConditions, it is directed to the Default Receiver. Please refer to the below diagram for clarity.
• The frequency of the alert and other features like silencing, inhibition, grouping and repetition are also governed by the Alertmanager configuration.

Working and Features ⚙️

• This tool parses the config and rules files. (Ignores comments if there are any!)
• Validates the yaml files for any indentation errors.
• Identifies the type of receiver (PD/Slack/Webhook/Email)
• Provides a picture of how Alerts are mapped to Receivers.
• It can handle labels/MatcherConditions with regex too.
• Implemented "continue:true" and Default Receiver logic in the routing.

Architecture 🗺️

Instructions 📕

1. Upload the Alertmanager Config file and click on submit.
2. Upload the first Thanos rules file and click on submit. After submitting plus button will be enabled to add additional files.
3. Click on Validate to verify whether the uploaded yaml files are valid.
4. Click on Visualize to view the set of receivers and routes.
5. Click on Map button to map receivers and routes.

Few Instances of the tool 📸

Future Enhancements 🗯️

1. Add Timer to visualize how long the alert stays in a receiver.
2. Add "Acknowledge" and "Resolve" buttons.
3. Add Templates to make use of .tmpl files to visualize how each alert looks like.
4. Add other features like silencing, inhibition, grouping and repetition.

HyperLinks 📎

Video Link : [https://www.youtube.com/watch?v=LOIbc1FvPWU]

If you wish to contribute to this project, you can go thru the To-Do tasks and ping me.

(31st July - 19th December 22)