Healthcheck extension for Pyramid
Project description
Simple healthcheck endpoint for Pyramid, with maintenance mode and application checks.
Bitbucket: https://github.com/ludia/pyramid_health
Installation
Install using setuptools, e.g. (within a virtualenv):
$ pip install pyramid_health
Setup
Once pyramid_health is installed, you must use the config.include mechanism to include it into your Pyramid project’s configuration. In your Pyramid project’s __init__.py:
config = Configurator(.....)
config.include('pyramid_health')
Alternately you can use the pyramid.includes configuration value in your .ini file:
[app:myapp]
pyramid.includes = pyramid_health
Usage
Pyramid_health configuration (values are defaults):
[app:myapp]
healthcheck.url = /health
healthcheck.disablefile = /tmp/maintenance # touch this file to activate
healthcheck.maintenance_code = 299 # Code to return in maintenance mode
healthcheck.failure_code = 503 # Code to return when one or more checks fail
Operation
When your application is healthy, pyramid_health endpoint returns 200 OK. When you enable the maintenance mode, the endpoint returns 299 MAINTENANCE and logs Health response: MAINTENANCE. If the request to the healthcheck endpoint asks for the application checks, and one application check or more return an error, the endpoint returns 503 ERROR and logs Health response: ERROR (<all-check-results>).
Application checks
The application checks are routines in your application that subscribe to pyramid_health.HealthCheckEvent event, execute a specific health check and report the outcome as a status (OK or ERROR) and an optional message.
The application checks are not called unless you explicitely request it with the request param checks set to true or all (like: GET /health?checks=all)
To add an application check in your application:
from pyramid.events import subscriber
from pyramid_health import HealthCheckEvent
@subscriber(HealthCheckEvent)
def db_check(event):
try:
db.ping()
except:
event.report(name='db', status='NOK', message='ping failed')
else:
event.report(name='db', status='OK')
Notes:
You may or may not report succeeding checks
Maintenance mode
In maintenance mode, the healthcheck endpoint’s response is changed to inform the HTTP client that this backend is unavailable. Typically a loadbalancer polling the backends would stop sending traffic to a backend in maintenance mode.
The response status code is 299 MAINTENANCE by default. You can change it with healthcheck.maintenance_code.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pyramid_health-1.2.1.tar.gz
.
File metadata
- Download URL: pyramid_health-1.2.1.tar.gz
- Upload date:
- Size: 4.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd4e1ee771fac739a3fdb3562cc4a7ff8965672dbd4c91a0b2c84b5e18190a22 |
|
MD5 | e9cc0b8a15724fa505683a4b48efbe6f |
|
BLAKE2b-256 | aa63dd193d92110291705c3943317b33a0e737a88f60514f1dfb51542c7d8954 |