HireFire 0.1

Django

Setting up HireFire support for Django is easy:

1. Add 'hirefire.contrib.django.middleware.HireFireMiddleware' to your ``MIDDLEWARE_CLASSES setting:

   MIDDLEWARE_CLASSES = [
       'hirefire.contrib.django.middleware.HireFireMiddleware',
       # ...
   ]

   Make sure it’s the first item in the list/tuple.

2. Define as many hirefire.procs.Proc subclasses as you want HireFire to monitor. Have a look at your Procfile file to do it.

   For example here is a Procfile which uses RQ for the worker proccess:

   web: python manage.py runserver
   worker: DJANGO_SETTINGS_MODULE=mysite.settings rqworker high default low

   Define a RQProc subclass somewhere in your Django project, e.g. mysite/procs.py, with the appropriate attributes (name and queues):

   from hirefire.procs.rq import RQProc
   
   class WorkerProc(RQProc):
       name = 'worker'
       queues = ['high', 'default', 'low']

   See the procs API documentation if you’re using another backend.

3. Set the HIREFIRE_PROCS setting to a list of dotted paths to your procs. For the above example proc:

   HIREFIRE_PROCS = ['mysite.procs.WorkerProc']

4. Set the HIREFIRE_TOKEN setting to the token that HireFire show on the specific application page (optional):

   HIREFIRE_TOKEN = 'f69f0c0ddebe041248daf187caa6abb3e5d943ca'

   This is only needed if you haven’t set the HIREFIRE_TOKEN environment variable already (see above).

5. Check that the middleware has been correctly setup by opening the following URL in a browser:

   http://localhost:8000/hirefire/test

   You should see an empty page with ‘HireFire Middleware Found!’.

   You can also have a look at the page that HireFire checks to get the number of current tasks:

   http://localhost:8000/hirefire/<HIREFIRE_TOKEN>/info

   where <HIREFIRE_TOKEN> needs to be replaced with your token or – in case you haven’t set the token in your settings or environment – just use development.