Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.48 KB

README.md

File metadata and controls

36 lines (25 loc) · 2.48 KB
Raw

A resource catalog for enterprise-class Prometheus monitoring

What is PromCat

Promcat is a project maintained by Sysdig that offers a curated catalog of setup guides, dashboards and alerts fully compatible with Prometheus and covering how to monitor the most important cloud native technologies.

You can find all the content organized and ready to use in promcat.io. Alternatively, feel free to explore the resources folder of this repository for the raw files and content.

What can I find?

PromCat comes as a crossroad for anyone that is looking for how to monitor a cloud application with Prometheus.

Here you will find the following contents for each application:

  • Setup Guides: A complete step-by-step guide to install and configure the Prometheus exporter or the metrics module of the application.
  • Dashboards: A set of dashboards to monitor for trouble-shooting and metrics exploration of the application. All dashboards are in Grafana format.
  • Alerts: A set of curated alerts for the application.
  • Recording Rules: A set of recording rules.

Who can use the resources?

The setup guides, dashboards and alerts can be used by any Prometheus user that needs to monitor cloud applications.

Contributing

As any open source project, all contributions are welcome.

You can contribute by:

  • Opening issues in this repository
  • Clone the repository and submit a pull request
  • Participate in the #promcat channel of the Sysdig public slack

As the main objective of PromCat is to offer high quality resources for professional users, all contributions will be review and tested before merging to mainstream by the maintainers.

Attributions

Most of the resources that you can find in PromCat are made and maintained by Sysdig under GPL3 license. You can check MAINTAINERS.md for more information.

However, each of the Prometheus exporters and other open source resources that are used, are attributed and referenced in each application folder. If you find any attribution or reference that can be improved or edited, you can open an issue in the repository, make a pull request to this repository or contact us via the #promcat channel of the Sysdig public slack.