Jobs can fail due to exceptions occurring. When your RQ workers run in the background, how do you get notified of these exceptions?
The default safety net for RQ is the
FailedJobRegistry. Every job that doesn’t
execute successfully is stored here, along with its exception information (type,
value, traceback). While this makes sure no failing jobs “get lost”, this is
of no use to get notified pro-actively about job failure.
RQ supports registering custom exception handlers. This makes it possible to inject your own error handling logic to your workers.
This is how you register custom exception handler(s) to an RQ worker:
from exception_handlers import foo_handler, bar_handler w = Worker([q], exception_handlers=[foo_handler, bar_handler])
The handler itself is a function that takes the following parameters:
def my_handler(job, exc_type, exc_value, traceback): # do custom things here # for example, write the exception info to a DB
You might also see the three exception arguments encoded as:
def my_handler(job, *exc_info): # do custom things here
The handler itself is responsible for deciding whether or not the exception
handling is done, or should fall through to the next handler on the stack.
The handler can indicate this by returning a boolean.
False means stop
True means continue and fall through to the next
exception handler on the stack.
It’s important to know for implementors that, by default, when the handler
doesn’t have an explicit return value (thus
None), this will be interpreted
True (i.e. continue with the next handler).
To prevent the next exception handler in the handler chain from executing, use a custom exception handler that doesn’t fall through, for example:
def black_hole(job, *exc_info): return False