Jun 28th, ‘24/3 min read

Prometheus Toolkit: Your Essential Companion for Monitoring

Building a standardized open-source resource across instrumentation, query, and alerting pipelines to start your monitoring journey with Prometheus.

Prometheus Toolkit: Your Essential Companion for Monitoring

With Levitate, we’ve been building a high-cardinality monitoring tool that reduces the toil of running your own Prometheus setup. Features like streaming aggregation, run-time alert group labels and rule filters, and macros that are reusable for querying and alerting enable customers to simplify and standardize usage across teams.

As we speak with our customers, be it small teams and early-stage startups with a lone SRE or large enterprises and unicorn startups with a dedicated reliability team — everyone seems to have a recurring problem across the pipeline.

How does one standardize their monitoring journey — from instrumentation to alerting?

Today, when you’re kickstarting your monitoring journey with Prometheus, it’s not an easy place to dive into right off the bat. One has to figure out which exporter to run, but then each exporter has their own nomenclature for emitted metrics, which then need their own set of alert rules and dashboards.

At the same time, they also have to deal with a painfully broken experience of using multiple resources and tools that enable the above.

How can Last9 help?

Project APT

Can Last9 make a toolkit to ease the pain?

A popular resource that many start with is https://github.com/samber/awesome-prometheus-alerts, maintained by Samuel Berthe. It’s a repository of alert rules configurations for your Prometheus setup. It seemed like a good place for us to start with.

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

As of launch, 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

Get Started

  1. Go to awesome-prometheus-toolkit and clone the repo locally
  2. Run npm install to install the dependencies
  3. Run npm run dev to run the dev server
  4. Open localhost:3000 in your browser
  5. Enter the URL of your local/test/production Prometheus server, and click Connect
    • You can also set the auth, if your server requires it
  6. 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
  7. If you have any additional components, you can also use the Browse Library section to find and copy those rules

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 Nginx metrics.

  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

What’s Next

With Levitate, we solve challenges at each step of the monitoring journey. And, we are aiming for the same with Awesome Prometheus Toolkit. We’ll focus on enabling standardization across the instrumentation, query, and alerting pipelines with APT.

In the coming weeks, we’ll add discovery support for more components and their alerting rules.

But we’re toying with the following ideas as well:

  • Enable applying rules via the UI, without the need to copy+paste them
  • Adding support for Grafana dashboards and their JSON configs
  • While the above rules are a great starting point, we see growing companies adapting them to be more dynamic and less noisy — so, rewriting these component rules based on our learnings with our customers

We’d love your thoughts and opinions on the project. And we’d love for you to contribute to APT so we can make the monitoring community’s lives easier quickly. Send us your PRs!

GitHub - last9/awesome-prometheus-toolkit: Alert rules toolkit for Prometheus. Connect Prometheus, discover alert rules, apply!
Alert rules toolkit for Prometheus. Connect Prometheus, discover alert rules, apply! - last9/awesome-prometheus-toolkit

Newsletter

Stay updated on the latest from Last9.

Authors

Sahil Khan

Product Marketing Manager

Handcrafted Related Posts