Flask Monitoring Dashboard

A dashboard for automatic monitoring of Flask web-services.

Key Features • How to use • Live Demo • Feedback • Documentation • Screenshots • License

Motivation

Key Features

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

• Monitor the performance and utilization:

The Dashboard allows you to see which endpoints process a lot of requests and how fast. Additionally, it provides information about the evolving performance of an endpoint throughout different versions if you're using git.

• Profile requests and endpoints:

The execution path of every request is tracked and stored into the database. This allows you to gain insight over which functions in your code take the most time to execute. Since all requests for an endpoint are also merged together, the Dashboard provides an overview of which functions are used in which endpoint.

• 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).

• Collect additional information about your Flask-application:

Suppose you have an User-table and you want to know how many users are registered on your Flask-application. Then, you can run the following query: 'SELECT Count(*) FROM USERS;'. But this is just annoying to do regularly. Therefore, you can configure this in the Flask-MonitoringDashboard, which will provide you this information per day (or other time interval).

• Exception Monitoring and Capturing

Flask-MonitoringDashboard automatically logs unhandled exceptions with full stack traces, showing where and why errors occur, if you have monitoring level 1 or above.

To capture handled exceptions manually and save them for displaying in the exception dashboard:

try:       # Your code   except Exception as e:       dashboard.capture(e)  # Logs exception with stack trace for debugging

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 more advanced documentation, take a look at the information on this site.

How to use

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)
@app.route("/test") def test():     return 'ok'
dashboard.bind(app) # Should be added after all endpoints have been defined app.run()

Live Demo

To view a live deployment of the Flask-MonitoringDashboard, check this site. Use the credentials u:admin, p:admin to log in.

Feedback

In order to improve our Flask-MonitoringDashboard, we would like to hear from you! Therefore, we made a questionnaire with a few questions. Filling in this form takes less than 3 minutes. You can find the form here.

Alternatively, feel free to write to our email-address.

Documentation

For more advanced documentation, see this site. If you run into trouble migrating from version 1.X.X to version 2.0.0, this site will help you solve this too.

Screenshots

Development

If you like our project, and willing to contribute, you can get started by cloning it and then running the following command:

. ./config/install.sh

For more information, check this page.

License

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