kaxil commented on code in PR #76860:
URL: https://github.com/apache/airflow/pull/76860#discussion_r4533333785
##########
providers/common/ai/docs/durable_execution.rst:
##########
@@ -312,16 +312,40 @@ accounting for a ``run`` window fails with a
``KeyError``. The ``run_id`` XCom,
failed attempt or a successful one, and the ``gen_ai.agent.call.id`` span
attribute carry
the same id; the spans of each attempt still carry that attempt's own
``airflow.task_instance.id`` and ``try_number``. The id is stored with the
journal and
-deleted with it, so a task cleared after it succeeded starts a new one.
+deleted with it, so a rerun after a clear that deleted the journal (see
+:ref:`durable-clear`) gets a new one.
Usage and limits
----------------
A replayed step adds nothing to the usage the run counts against
``usage_limits`` or
reports in the ``usage`` XCom: not its request, tokens, cost or tool calls,
nor the
usage a replayed ``@durable_operation`` brings back. Each attempt counts only
the calls
-it actually makes. This holds after clearing a failed task instance too: the
clear
-starts a fresh budget but keeps the journal, and what the rerun replays from
it is free.
+it actually makes. Clearing a finished task instance starts a fresh budget; if
the
+rerun replays from the journal (see :ref:`durable-clear`), the replayed steps
cost nothing.
+
+.. _durable-clear:
+
+Clearing a task
+---------------
+
+On Airflow 3.4 and later, clearing a task instance (its Clear dialog in the
UI, or
+``POST /api/v2/dags/{dag_id}/clearTaskInstances``) deletes its task state, the
journal
+included, so the rerun starts the agent over. This holds for the default task
state store
+backend; a custom ``[state_store] backend`` keeps its entries. To resume from
the journal
+instead, tick **Keep task state and resume** in the dialog, or send
+``"keep_task_state": true`` in the request. The **Keep task state on clear**
UI setting
+ticks that box by default. Clearing the whole Dag run from the Clear Run
dialog keeps task
+state; "Retries resume, clearing starts over" in
+:ref:`apache-airflow:concepts-resumable-tasks` lists the other ways of
clearing and which
+of them keep it.
+
+Before Airflow 3.4 no clear deletes the journal (the task state store on 3.3,
the file
+under ``durable_cache_path`` earlier), so a cleared task replays.
+
+A task that succeeded has no journal left, so clearing it starts over either
way. For
Review Comment:
Good catch, applied in 04ba9c072f0.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
