Skip to content

Alert rules toolkit for Prometheus. Connect Prometheus, discover alert rules, apply!

Notifications You must be signed in to change notification settings

last9/awesome-prometheus-toolkit

Repository files navigation

Awesome Prometheus Toolkit

The most apt toolkit for your Prometheus setup.

Kickstarting your monitoring journey with Prometheus is a broken experience and one struggles with a standardized set of components, alerting rules, and dashboards to use. APT aims to build a standardized resource across the instrumentation, query, and alerting pipelines.

With the v0.1 of Awesome Prometheus Toolkit, we are setting a foundation for an amazing Prometheus developer experience we want:

  1. You point APT to your running Prometheus server
  2. APT identifies which components are sending metrics to Prometheus
  3. APT gives recommendations on what alert rules (sourced from awesome-prometheus-alerts) should be applied

Read our launch blog post here.

Demo of Awesome Prometheus Toolkit

Currently, APT gives you recommendations and tracks which rules are already applied for the following components:

  1. Clickhouse
  2. Elasticsearch
  3. HaProxy
  4. Kubernetes
  5. Nginx
  6. PostgreSQL

💻 Getting Started

  1. Run npm install to install the dependencies
  2. Run npm run dev to run the dev server
  3. Open localhost:3000 in your browser
  4. Enter the URL of your local/test/production Prometheus server, and click Connect
    • You can also set the auth, if your server requires it
  5. Once APT identifies the supported components in your emitted metrics, you can view the recommendations. You can simply copy the recommended rules and apply them in your Prometheus’ rules.yml
  6. If you have any additional components, you can also use the Browse Library section to find and copy those rules

🔧 Setup Demo Prometheus Server (Optional)

If you don’t have a Prometheus server handy but still want to play around with APT, you can also use the demo setup provided in the repo to generate metrics for the supported components (except Kubernetes).

  1. Run cd promtheus-server
  2. Run docker compose up to start the local server
  3. Use localhost:9090 as the source URL on the APT home screen, without any required auth

About Last9

Last9 builds reliability tools for SRE and DevOps.

Releases

No releases published

Languages