From d2f0e0de1dc6d3e6765b3770aeea521b5ae0fa82 Mon Sep 17 00:00:00 2001 From: Paolo Di Tommaso Date: Wed, 23 Oct 2024 11:45:33 +0200 Subject: [PATCH] Update docs [ci skip] Signed-off-by: Paolo Di Tommaso --- docs/reference/process.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/reference/process.md b/docs/reference/process.md index 843729589b..de462539a4 100644 --- a/docs/reference/process.md +++ b/docs/reference/process.md @@ -29,14 +29,16 @@ The following task properties are defined in the process body: `task.previousException` : :::{versionadded} 24.10.0 ::: -: The task execution of previous execution. -: Since the exception is only available after the task has been executed, it can only be used when `task.attempt` is bigger than 1. +: The exception reported by the previous task attempt. +: Since the exception is only available after a failed task execution, it can only be used when `task.attempt` is greater than 1. `task.previousTrace` : :::{versionadded} 24.10.0 ::: -: The trace record of the task execution. -: Since the trace record is only available after the task has been executed, it can only be used when `task.attempt` is bigger than 1. +: The trace record associated with the previous task attempt. Since the trace record is only available after the task + has been executed, it can only be accessed when retrying a failed task execution, and therefore when `task.attempt` + is greater than 1. +: This is useful when retrying a task execution to access the previous task attempt runtime metrics e.g. used memory and CPUs. `task.process` : The current process name.