How jack-samu/flask-monitoring-kit works
Project type and purpose
• This is an “add-on” open-source monitoring kit for Flask applications.
• It provides automatic instrumentation of latency, traffic, error rate, saturation (four Golden Signals), plus simple MySQL monitoring.
• It uses Docker Compose to spin up Prometheus, Grafana, and a MySQL exporter alongside your Flask app.
File structure
• Top‐level Docker Compose file: docker-compose-monitoring.yml
• Defines services: prometheus, grafana, mysqld-exporter, plus any network settings.
• monitoring/ Python package
• metrics.py, middleware.py, saturation.py, transaction.py – instrumentation logic you import in your Flask factory.
• prometheus/ directory
• prometheus.yml – scrape configs for your Flask app and MySQL exporter
• alerts.yml – alerting rules
• grafana/ directory
• config/grafana.ini – Grafana server settings (admin credentials)
• provisioning/datasources/prometheus.yml – auto-add Prometheus as data source
• provisioning/dashboards/flask_dashboard.json – predefined dashboards
README insights
• Integration steps: clone repo under vendor/, include Compose file, set Grafana admin env vars, call init_metrics(app, db) in Flask.
• Usage patterns: exposes /metrics endpoint, relies on Prometheus pull model.
Elements
• Code-level (blue): Flask app + monitoring package
• System-level (green): Prometheus, Grafana, MySQL exporter
• External (grey): MySQL database
• Prometheus → Flask app (HTTP /metrics)
• Prometheus → MySQL exporter
• MySQL exporter → MySQL DB (TCP)
• Grafana → Prometheus (HTTP API)