Healthchecks Decorator

A simple python decorator for healthchecks.io.

Features

The healthchecks-decorator library provides the following features:

• 🚀 Easy to use: Simply decorate your function with @healthcheck to enable health checks.
• ⏲️ Execution time measurement: Supports sending /start signals to measure job execution times.
• 🔥 Exception handling: Automatically sends /failure signals when jobs produce exceptions.
• 🤖 Auto-provisioning: Supports automatic provisioning of new health checks by adding ?create=1 to the ping URL.
• 🌡️ Diagnostics information: Send diagnostics information to help diagnose issues.
• 😊 Flexible endpoint support: Supports both SaaS and self-hosted endpoints.

Requirements

• None - just pure python 🐍.

Installation

You can install Healthchecks Decorator via pip from PyPI:

$ pip install healthchecks-decorator

Usage

Basic usage

from healthchecks_decorator import healthcheck

@healthcheck(url="https://hc-ping.com/<uuid1>")
def job():
   """Job with a success healthcheck signal when done"""
   pass


@healthcheck(url="https://hc-ping.com/<uuid2>", send_start=True)
def job_with_start():
   """Send also a /start signal before starting"""
   pass


@healthcheck(url="https://hc-ping.com/<uuid3>")
def job_with_exception():
   """This will produce a /fail signal"""
   raise Exception("I'll be propagated")


@healthcheck(url="https://hc-ping.com/<uuid4>", send_diagnostics=True)
def job_with_diagnostics():
   """Send the returned value in the POST body.
   The returned value must be a valid input for `urllib.parse.urlencode`.
   Otherwise, nothing will be sent."""
   return {"temperature": -7}

Environment variables

It is possible to set options through environment variables. Each option has a corresponding environment variable defined by the option name in upper snake case with the HEALTHCHECK_ prefix.

For example, setting:

• HEALTHCHECK_URL=http://fake-hc.com/uuid
• HEALTHCHECK_SEND_DIAGNOSTICS=TRUE
• HEALTHCHECK_SEND_START=1

will allow having the most minimalist usage:

@healthcheck
def job():
   """Url, send_diagnostics and send_start are grabbed from environment."""
   pass

Note

Boolean options will be parsed as True if the env var is set to the word 'true' (in any case) or '1'. Otherwise, the option is set to False.

Note

Explicit values take precedence over environment variables.

Please see the Documentation for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Healthchecks Decorator is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

• healthchecks.io.
• This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.