https://github.com/schabi88/healthcheck-extended
Write simple healthcheck functions for your Flask apps.
https://github.com/schabi88/healthcheck-extended
Last synced: 4 months ago
JSON representation
Write simple healthcheck functions for your Flask apps.
- Host: GitHub
- URL: https://github.com/schabi88/healthcheck-extended
- Owner: schabi88
- License: mit
- Fork: true (ashimali/healthcheck)
- Created: 2020-09-28T06:36:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-28T16:05:27.000Z (over 4 years ago)
- Last Synced: 2024-03-15T01:56:47.935Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - schabi88/healthcheck-extended - Write simple healthcheck functions for your Flask apps. (Python)
README
Healthcheck-Extended
----------
Healthcheck wraps a Flask app object and adds a way to write simple healthcheck
functions that can be used to monitor your application. It's useful for
asserting that your dependencies are up and running and your application can
respond to HTTP requests. The Healthcheck functions are exposed via a user
defined flask route so you can use an external monitoring application (monit,
nagios, Runscope, etc.) to check the status and uptime of your application.
New in version 1.1: Healthcheck also gives you a simple Flask route to view
information about your application's environment. By default, this includes
data about the operating system, the Python environment, the current process,
and the application config. You can customize which sections are included, or
add your own sections to the output.
This fork contains some tweaks, mostly regarding a more flexible timestamp
format handling to make it more usable.
Forked from: https://github.com/Runscope/healthcheck
### Version 1.3.4
- Add support for UTC timestamps
## Installing
```
pip install healthcheck-extended
```
## Usage
Here's an example of basic usage:
```python
from flask import Flask
from healthcheck_extended import HealthCheck, EnvironmentDump
app = Flask(__name__)
# wrap the flask app and give a heathcheck url
health = HealthCheck(app, "/healthcheck")
envdump = EnvironmentDump(app, "/environment")
# add your own check function to the healthcheck
def redis_available():
client = _redis_client()
info = client.info()
return True, "redis ok"
health.add_check(redis_available)
# add your own data to the environment dump
def application_data():
return {"maintainer": "Frank Stratton",
"git_repo": "https://github.com/Runscope/healthcheck"}
envdump.add_section("application", application_data)
```
To run all of your check functions, make a request to the healthcheck URL
you specified, like this:
```
curl "http://localhost:5000/healthcheck"
```
And to view the environment data, make a check to the URL you specified for
EnvironmentDump:
```
curl "http://localhost:5000/environment"
```
## The HealthCheck class
### Check Functions
Check functions take no arguments and should return a tuple of (bool, str).
The boolean is whether or not the check passed. The message is any string or
output that should be rendered for this check. Useful for error
messages/debugging.
```python
# add check functions
def addition_works():
if 1 + 1 == 2:
return True, "addition works"
else:
return False, "the universe is broken"
```
Any exceptions that get thrown by your code will be caught and handled as
errors in the healthcheck:
```python
# add check functions
def throws_exception():
bad_var = None
bad_var['explode']
```
Will output:
```json
{
"status": "failure",
"results": [
{
"output": "'NoneType' object has no attribute '__getitem__'",
"checker": "throws_exception",
"passed": false
}
]
}
```
Note, all checkers will get run and all failures will be reported. It's
intended that they are all separate checks and if any one fails the
healthcheck overall is failed.
### Caching
In Runscope's infrastructure, the /healthcheck endpoint is hit surprisingly
often. haproxy runs on every server, and each haproxy hits every healthcheck
twice a minute. (So if we have 30 servers in our infrastructure, that's 60
healthchecks per minute to every Flask service.) Plus, monit hits every
healthcheck 6 times a minute.
To avoid putting too much strain on backend services, health check results can
be cached in process memory. By default, health checks that succeed are cached
for 27 seconds, and failures are cached for 9 seconds. These can be overridden
with the `success_ttl` and `failed_ttl` parameters. If you don't want to use
the cache at all, initialize the Healthcheck object with `success_ttl=None,
failed_ttl=None`.
### Customizing
You can customize the status codes, headers, and output format for success and
failure responses.
## The EnvironmentDump class
### Built-in data sections
By default, EnvironmentDump data includes these 4 sections:
* `os`: information about your operating system.
* `python`: information about your Python executable, Python path, and
installed packages.
* `process`: information about the currently running Python process, including
the PID, command line arguments, and all environment variables.
* `config`: information about your Flask app's configuration, pulled from
`app.config`.
Some of the data is scrubbed to avoid accidentally exposing passwords or access
keys/tokens. Config keys and environment variable names are scanned for `key`,
`token`, or `pass`. If those strings are present in the name of the variable,
the value is not included.
### Disabling built-in data sections
For security reasons, you may want to disable an entire section. You can
disable sections when you instantiate the `EnvironmentDump` object, like this:
```python
envdump = EnvironmentDump(app, "/environment",
include_python=False, include_os=False,
include_process=False, include_config=False)
```
### Adding custom data sections
You can add a new section to the output by registering a function of your own.
Here's an example of how this would be used:
```python
def application_data():
return {"maintainer": "Frank Stratton",
"git_repo": "https://github.com/Runscope/healthcheck"}
envdump = EnvironmentDump(app, "/environment")
envdump.add_section("application", application_data)
```