📊 Strapi Prometheus Plugin

A powerful middleware plugin that adds comprehensive Prometheus metrics to your Strapi application using @prometheus-io/client 📈. Monitor your API performance, track system resources, and gain valuable insights into your application's behavior with just a few lines of configuration! 🚀

✨ Features

• 🚀 Real-time API Metrics - Track HTTP request duration, payload sizes, and response codes with intelligent route normalization
• 📈 System Monitoring - Collect Node.js process metrics as recommended by Prometheus
• 🔒 Private by Default - Dedicated metrics server binds to 127.0.0.1:9000, isolated from your main application and not reachable from outside the host until you opt in
• 🏷️ Custom Labels - Add custom labels to categorize and filter your metrics across environments 🌍
• 📊 Database Lifecycle Tracking - Monitor Strapi lifecycle events (create, update, delete) duration ⚡
• 🔌 Easy Integration - Simple configuration with sensible defaults - get started in minutes!
• 🆔 Version Tracking - Monitor Strapi version information for deployment tracking
• 🎯 Smart Path Normalization - Flexible normalization with regex patterns or custom functions to group similar routes for better metric cardinality 📊
• 📦 TypeScript Support - Built with TypeScript for better developer experience

⚡ Installation

1. Install the package 📦

npm install strapi-prometheus
# or
yarn add strapi-prometheus
# or
pnpm add strapi-prometheus

2. Enable the plugin ⚙️

// config/plugins.js
module.exports = {
  prometheus: {
    enabled: true,
  },
};

Start Strapi and metrics are served at http://127.0.0.1:9000/metrics 📊. See Configuration for custom labels, server settings, and path normalization.

[!CAUTION] The metrics endpoint is not authenticated. Read the security policy before exposing it beyond localhost.

🤝 Compatibility

Upgrading? See the migration guides for v2 → v3 and v1 → v2.

📖 Documentation

• Configuration
• Metrics
• Path Normalization
• Grafana Dashboards
• Troubleshooting
• Security · Contributing · Support

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author & Maintainer

Xander Denecker (@XanderD99)

• 🐙 GitHub: XanderD99
• ☕ Buy me a coffee: buymeacoffee.com/xanderd

🙏 Acknowledgments

• Prometheus - The monitoring system that makes this all possible
• @prometheus-io/client - The Node.js Prometheus client library
• Strapi - The leading open-source headless CMS
• All contributors who have helped improve this plugin

⭐ If this plugin helps you, please consider giving it a star on GitHub!