This document describes an older version of Celery (2.1). For the latest stable version please go here.
Several kinds of events trigger signals, you can connect to these signals to perform actions as they trigger.
Example connecting to the task_sent signal:
from celery.signals import task_sent
def task_sent_handler(sender=None, task_id=None, task=None, args=None,
kwargs=None, **kwds):
print("Got signal task_sent for task id %s" % (task_id, ))
task_sent.connect(task_sent_handler)
Some signals also have a sender which you can filter by. For example the task_sent signal uses the task name as a sender, so you can connect your handler to be called only when tasks with name "tasks.add" has been sent by providing the sender argument to connect:
task_sent.connect(task_sent_handler, sender="tasks.add")
Dispatched when a task has been sent to the broker. Note that this is executed in the client process, the one sending the task, not in the worker.
Sender is the name of the task being sent.
Provides arguments:
Id of the task to be executed.
The task being executed.
the tasks positional arguments.
The tasks keyword arguments.
The time to execute the task.
Id of the taskset this task is part of (if any).
Dispatched before a task is executed.
Sender is the task class being executed.
Provides arguments:
Id of the task to be executed.
The task being executed.
the tasks positional arguments.
The tasks keyword arguments.
Dispatched after a task has been executed.
Sender is the task class executed.
Provides arguments:
Id of the task to be executed.
The task being executed.
The tasks positional arguments.
The tasks keyword arguments.
retval
The return value of the task.
Dispatched before the worker is started.
Dispatched when the worker is ready to accept work.
Dispatched by each new pool worker process when it starts.
Dispatched when the worker is about to shut down.