healthchecks

healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface.

It is live here: http://healthchecks.io/

The building blocks are:

• Python 2 or Python 3
• Django 1.8
• PostgreSQL or MySQL

Setting Up for Development

These are instructions for setting up HealthChecks Django app in development environment.

• prepare directory for project code and virtualenv:

    $ mkdir -p ~/webapps
    $ cd ~/webapps
  

• prepare virtual environment (with virtualenv you get pip, we'll use it soon to install requirements):

    $ virtualenv --python=python3 hc-venv
    $ source hc-venv/bin/activate
  

• check out project code:

    $ git clone [email protected]:healthchecks/healthchecks.git
  

• install requirements (Django, ...) into virtualenv:

    $ pip install -r healthchecks/requirements.txt
  

• make sure PostgreSQL server is installed and running, create database "hc":

    $ psql --user postgres
    postgres=# create database hc;
  

• create database tables, triggers, superuser:

    $ cd ~/webapps/healthchecks
    $ ./manage.py migrate
    $ ./manage.py ensuretriggers
    $ ./manage.py createsuperuser
  

• run development server:

    $ ./manage.py runserver
  

Sending Emails

healthchecks must be able to send email messages, so it can send out login links and alerts to users. You will likely need to tweak email configuration before emails will work. healthchecks uses djmail for sending emails asynchronously. Djmail is a BSD Licensed, simple and nonobstructive django email middleware. It can be configured to use any regular Django email backend behind the scenes. For example, the healthchecks.io site uses django-ses-backend and the email configuration in hc/local_settings.py looks as follows:

DJMAIL_REAL_BACKEND = 'django_ses_backend.SESBackend'
AWS_SES_ACCESS_KEY_ID = "put-access-key-here"
AWS_SES_SECRET_ACCESS_KEY = "put-secret-access-key-here"
AWS_SES_REGION_NAME = 'us-east-1'
AWS_SES_REGION_ENDPOINT = 'email.us-east-1.amazonaws.com'

Sending Status Notifications

healtchecks comes with a sendalerts management command, which continuously polls database for any checks changing state, and sends out notifications as needed. Within an activated virtualenv, you can manually run the sendalerts command like so:

$ ./manage.py sendalerts

In a production setup, you will want to run this command from a process manager like supervisor or systemd.

Integrations

Pushover

To enable Pushover integration, you will need to:

• register a new application on https://pushover.net/apps/build
• enable subscriptions in your application and make sure to enable the URL subscription type
• add the application token and subscription URL to hc/local_settings.py, as PUSHOVER_API_TOKEN and PUSHOVER_SUBSCRIPTION_URL