Health checks for your Sanic applications
Project description
sanic-healthcheck
sanic-healthcheck
provides a simple way to add health checks and readiness checks to
your Sanic application. This makes it easier to
monitor your application and ensure it is running in a health state. Monitoring or management
tools can ping these endpoints to determine application uptime and status, as well as perform
application restart to ensure your application isn't running in a degraded state.
sanic-healthcheck
was inspired by and borrows from Runscope/healthcheck.
Installing
pip install sanic-healthcheck
Documentation
For full project documentation, see: https://sanic-healthcheck.readthedocs.io/en/latest/
Example
Below is a trivial example showcasing basic usage of sanic-healthcheck
import random
from sanic import Sanic, response
from sanic_healthcheck import HealthCheck
app = Sanic()
health_check = HealthCheck(app)
@app.route('/')
async def test(request):
return response.json({'hello', 'world'})
# Define checks for the health check.
def check_health_random():
if random.random() > 0.9:
return False, 'the random number is > 0.9'
return True, 'the random number is <= 0.9'
if __name__ == '__main__':
health_check.add_check(check_health_random)
app.run(host='0.0.0.0', port=8000)
License
sanic-healthcheck
is licensed under the MIT license. See LICENSE for details.
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 sanic_healthcheck-0.1.1.tar.gz
.
File metadata
- Download URL: sanic_healthcheck-0.1.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 107230dc6f3594977b8f71d3c5a624c40b2c7c0ebf2650192d0cf9401dfadf72 |
|
MD5 | 80c395bcc0a652005b112d84ced3d2bc |
|
BLAKE2b-256 | 33807fa35f906588f8c97ddc10d87799dbd32fe739cd3389c6fbfb4d311c5a75 |
File details
Details for the file sanic_healthcheck-0.1.1-py2.py3-none-any.whl
.
File metadata
- Download URL: sanic_healthcheck-0.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2e5b5717de59a3b87d9abcf3b3a32fe181e911fc4eccfe06cf070630f27ca02 |
|
MD5 | a7b77b8575c441853535032e6cd37451 |
|
BLAKE2b-256 | c4718aa293ce4bd1f1afd9775f04c92d4cb6dab28f2aa809dc3eea65acf30559 |