Home

Awesome

<h1 align="center"> <img src="/docs/img/header.png" width="600"> <br> Flask Monitoring Dashboard <br> </h1> <p align="center"> A dashboard for automatic monitoring of <a href="https://flask.palletsprojects.com/" target="_blank">Flask</a> web-services. </p> <span align="center">

Continous Integration

Documentation Status codecov PyPI version Py-version Downloads Tweet

</span> <p align="center"> <a href="#key-features">Key Features</a> • <a href="#how-to-use">How to use</a> • <a href="#live-demo">Live Demo</a> • <a href="#feedback">Feedback</a> • <a href="#documentation">Documentation</a> • <a href="#screenshots">Screenshots</a> • <a href="#license">License</a> </p>

gif

Motivation

<img width="592" alt="image" src="https://user-images.githubusercontent.com/464519/210054732-bf97cfaa-fb66-4a9f-affb-7004f531b34c.png">

Key Features

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

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

Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4 Screenshot 5

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.