Browse Source

Document the runtime argument to the task-succeeded event.

Ask Solem 15 years ago
parent
commit
9f1c95c347
2 changed files with 5 additions and 3 deletions
  1. 4 3
      docs/internals/events.rst
  2. 1 0
      docs/internals/index.rst

+ 4 - 3
docs/internals/events.rst

@@ -16,11 +16,12 @@ Task Events
 
     Sent just before the worker executes the task.
 
-* task-succeeded(uuid, result, hostname, timestamp)
+* task-succeeded(uuid, result, runtime, 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.)
+    Runtime is the time it took to execute the task using the pool.
+    (Time starting from the task is sent to the pool, and ending when the
+    pool result handlers callback is called).
 
 * task-failed(uuid, exception, traceback, hostname, timestamp)
 

+ 1 - 0
docs/internals/index.rst

@@ -10,4 +10,5 @@
 
     worker
     protocol
+    events
     reference/index