https://github.com/andersinno/healthbip
Django Application Healthchecks
https://github.com/andersinno/healthbip
Last synced: 11 months ago
JSON representation
Django Application Healthchecks
- Host: GitHub
- URL: https://github.com/andersinno/healthbip
- Owner: andersinno
- License: mit
- Created: 2019-11-27T13:55:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-27T14:29:16.000Z (over 6 years ago)
- Last Synced: 2025-01-19T07:25:10.490Z (over 1 year ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Health Bip
Django health checks for Kubernetes
## Installation
### PIP
`pip install healthbip`
### Poetry
`poetry add healthbip`
## Usage
Health Bip comes with two ways that is can be used. Either via URLs or via middleware,
the choice of installation is up to the user and both ways support being extended by
by subclassing the implementations.
### Add to Django apps
In your `DJANGO_APPS` settings, add `healthbip`.
```python
DJANGO_APPS = [
...,
"healthbip",
...,
]
```
### URLs
In the projects main URL file, add the following:
```python
from healthblip.urls import health_urls
urlpatterns += health_urls
```
### Middleware
In the projects middleware settings, add the following:
```python
MIDDLEWARE = [
"healthblip.middleware.HealthCheckMiddleware",
...,
]
```
Note that middleware ordering is taken into consideration when Django runs them, so the
higher up you place the middleware the earlier it will be evaluated.