Flask-Meter adds a healthcheck endpoint for Flask apps.
Project description
Healthchecks for Flask Apps
Flask-Meter is an add-on to the Flask web framework. Flask-Meter adds a monitoring endpoint for consuming application metrics. It can be really simple to set up. Flask-Meter modifies the Flask application to provide an enpoint at /_health where you will get a JSON response of the system’s uptime, current git revision.
You can also add in extra checks by passing in a list of checks to the constructor.
Installing
Install and update using pip:
pip install -U Flask-Meter
Flask Configuration
from Flask import Flask
from flask_meter import FlaskMeter
app = Flask(__name__)
FlaskMeter(app)
Or if you can use the init_app function:
from Flask import Flask
from flask_meter import FlaskMeter
app = Flask(__name__)
flask_meter = FlaskMeter()
flask_meter.init_app(app)
Free software: MIT license
Documentation: https://flask-meter.readthedocs.io.
Features
Current Git Commit
Current Version
Accepts custom functions
Configuration
Config Key |
Description |
Type |
Default |
---|---|---|---|
FLASK_METER_ENABLE |
Enable/Disable Flask-Meter |
bool |
True |
FLASK_METER_GIT |
Enable/Disable Git Stats |
bool |
True |
FLASK_METER_VERSION |
Enable/Disable Version Stats |
bool |
True |
Sponsorship
Put your logo here! Become a sponsor and support this project!
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Flask-Meter-1.1.2.tar.gz
.
File metadata
- Download URL: Flask-Meter-1.1.2.tar.gz
- Upload date:
- Size: 18.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99dcf6902fc26995ab12305931795d57cdabf5b93a70ca08dee23cf3c99523c7 |
|
MD5 | 29a0c6658ae13d534090e73751eda1ef |
|
BLAKE2b-256 | 8f43ee8f97d21f3008931c1fb7b081b1a2d1c0c182aebff999361107febcc959 |
File details
Details for the file Flask_Meter-1.1.2-py3-none-any.whl
.
File metadata
- Download URL: Flask_Meter-1.1.2-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e8378866d9c3ff84df4c38021dcbb4f17491ee435732474fed0379d9c7b67c1 |
|
MD5 | 6405c375e96adb0b95552415b4326e84 |
|
BLAKE2b-256 | e13f6bee1cf3f15166f7ba9ffb5236d2a0de6da13ceaa0d2a5d382f1c9935533 |