events: Documentation: Added list of events sent by the worker.

docs/internals/events.rst

@@ -0,0 +1,48 @@
+=======================
+ List of Worker Events
+=======================
+
+This is the list of events sent by the worker.
+The monitor uses these to visualize the state of the cluster.
+
+Task Events
+-----------
+
+* task-received(uuid, name, args, kwargs, retries, eta, hostname, timestamp)
+
+    Sent when the worker receives a task.
+
+* task-accepted(uuid, hostname, timestamp)
+
+    Sent just before the worker executes the task.
+
+* task-succeeded(uuid, result, hostname, timestamp)
+
+    Sent if the task executed successfully.
+    (EDIT: Should probably add the time it took to execute the task here?
+    Then we could get rid of the old statistics code.)
+
+* task-failed(uuid, exception, traceback, hostname, timestamp)
+
+    Sent if the execution of the task failed.
+
+* task-retried(uuid, exception, traceback, hostname, delay, timestamp)
+
+    Sent if the task failed, but will be retried in the future.
+    (**NOT IMPLEMENTED**)
+
+Worker Events
+-------------
+
+* worker-online(hostname, timestamp)
+
+    The worker has connected to the broker and is online.
+
+* worker-heartbeat(hostname, timestamp)
+
+    Sent every minute, if the worker has not sent a heartbeat in 2 minutes,
+    it's considered to be offline.
+
+* worker-offline(hostname, timestamp)
+
+    The worker has disconnected from the broker.