HireFire 1.0

Add 'hirefire.contrib.django.middleware.HireFireMiddleware' to your MIDDLEWARE setting

# Use ``MIDDLEWARE_CLASSES`` prior to Django 1.10
MIDDLEWARE = [
    'hirefire.contrib.django.middleware.HireFireMiddleware',
    # ...
]

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

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

HIREFIRE_PROCS = ['mysite.procs.WorkerProc']

Set the HIREFIRE_TOKEN setting to the token that HireFire shows 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 the installation section how to do that on Heroku).

Add 'hirefire.contrib.django.middleware.QueueTimeMiddleware' to your MIDDLEWARE setting to enable HireFire’s support for scaling according to Heroku request queue times (optional).

# Use ``MIDDLEWARE_CLASSES`` prior to Django 1.10
MIDDLEWARE = [
    'hirefire.contrib.django.middleware.HireFireMiddleware',
    # ...
]

Make sure to place it before any other item in the list/tuple so that request queue time is calculated as accurately as possible.

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.

Use hirefire.contrib.tornado.handlers.hirefire_handlers when defining your tornado.web.Application instance

import os
from hirefire.contrib.tornado.handlers import hirefire_handlers

application = tornado.web.Application([
    # .. some patterns and handlers
] + hirefire_handlers(os.environ['HIREFIRE_TOKEN'],
                      ['mysite.procs.WorkerProc']))

Make sure to pass a list of dotted paths to the hirefire_handlers function.

Set the HIREFIRE_TOKEN environment variable to the token that HireFire shows on the specific application page (optional)

export HIREFIRE_TOKEN='f69f0c0ddebe041248daf187caa6abb3e5d943ca'

See the installation section above for how to do that on Heroku.

Check that the handlers have been correctly setup by opening the following URL in a browser:

http://localhost:8888/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:8888/hirefire/<HIREFIRE_TOKEN>/info

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

The module hirefire.contrib.flask.blueprint provides a build_hirefire_blueprint factory function that should be called with HireFire token and procs as arguments. The result is a blueprint providing the hirefire routes and which should be registered inside your app

import os
from flask import Flask
from hirefire.contrib.flask.blueprint import build_hirefire_blueprint

app = Flask(__name__)
bp = build_hirefire_blueprint(os.environ['HIREFIRE_TOKEN'],
                              ['mysite.procs.WorkerProc'])
app.register_blueprint(bp)

Make sure to pass a list of dotted paths to the build_hirefire_blueprint function.

Set the HIREFIRE_TOKEN environment variable to the token that HireFire shows on the specific application page (optional)

export HIREFIRE_TOKEN='f69f0c0ddebe041248daf187caa6abb3e5d943ca'

See the installation section above for how to do that on Heroku.

Check that the handlers have been correctly setup by opening the following URL in a browser:

http://localhost:8080/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:8080/hirefire/<HIREFIRE_TOKEN>/info

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