Skip to content

Qqwy/Flask-MonitoringDashboard

 
 

Repository files navigation

Flask Monitoring Dashboard

Dashboard for automatic monitoring of Flask web-services.

The Flask Monitoring Dashboard is an extension that offers four main functionalities with little effort from the Flask developer:

  • Monitor the Flask application: Our Dashboard allows you to see which endpoints process a lot of request and how fast. Additionally, it provides information about the evolving performance of an endpoint throughout different versions if you’re using git.

  • Monitor your test coverage: The dashboard allows you to find out which endpoints are covered by unit tests, allowing also for integration with Travis for automation purposes. For more information, see this file.

  • Collect extra information about outliers: Outliers are requests that take much longer to process than regular requests. The dashboard automatically detects that a request is an outlier and stores extra information about it (stack trace, request values, Request headers, Request environment).

  • Visualize the collected data in a number useful graphs: The dashboard is automatically added to your existing Flask application. You can view the results by default using the default endpoint (this can be configured to another route):

    /dashboard

For a more advanced documentation, take a look at the information on this site.

Status

Build Status Documentation Status

Installation

To install from source, download the source code, then run this:

python setup.py install

Or install with pip:

pip install flask_monitoringdashboard

Setup

Adding the extension to your Flask app is simple:

from flask import Flask
import flask_monitoringdashboard as dashboard

app = Flask(__name__)
dashboard.bind(app)

Documentation

For a more advanced documentation, see this site.

Screenshots

Screenshot 1 Screenshot 2

About

Automatically monitor the evolving performance of Flask/Python web services.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 34.9%
  • Python 32.1%
  • CSS 23.2%
  • HTML 9.8%