You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by mo...@apache.org on 2023/12/21 12:47:55 UTC
(airflow) branch remove-experimental-listener created (now 6db16cc01c)
This is an automated email from the ASF dual-hosted git repository.
mobuchowski pushed a change to branch remove-experimental-listener
in repository https://gitbox.apache.org/repos/asf/airflow.git
at 6db16cc01c note that task instance, dag and lifecycle listeners are non-experimental
This branch includes the following new commits:
new 6db16cc01c note that task instance, dag and lifecycle listeners are non-experimental
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(airflow) 01/01: note that task instance, dag and lifecycle listeners are non-experimental
Posted by mo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mobuchowski pushed a commit to branch remove-experimental-listener
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 6db16cc01c080d8f6434fe19fddcf8d4df798a53
Author: Maciej Obuchowski <ob...@gmail.com>
AuthorDate: Thu Dec 21 11:46:28 2023 +0100
note that task instance, dag and lifecycle listeners are non-experimental
Signed-off-by: Maciej Obuchowski <ob...@gmail.com>
---
.../administration-and-deployment/listeners.rst | 8 ++++----
newsfragments/1234.significant.rst | 18 ++++++++++++++++++
2 files changed, 22 insertions(+), 4 deletions(-)
diff --git a/docs/apache-airflow/administration-and-deployment/listeners.rst b/docs/apache-airflow/administration-and-deployment/listeners.rst
index 0672e07779..19f5d27646 100644
--- a/docs/apache-airflow/administration-and-deployment/listeners.rst
+++ b/docs/apache-airflow/administration-and-deployment/listeners.rst
@@ -58,6 +58,9 @@ Dataset Events
Dataset events occur when Dataset management operations are run.
+|experimental|
+
+
Usage
-----
@@ -68,9 +71,6 @@ To create a listener:
Airflow defines the specification as `hookspec <https://github.com/apache/airflow/tree/main/airflow/listeners/spec>`__. Your implementation must accept the same named parameters as defined in hookspec. If you don't use the same parameters as hookspec, Pluggy throws an error when you try to use your plugin. But you don't need to implement every method. Many listeners only implement one method, or a subset of methods.
-To include the listener in your Airflow installation, include it as a part of an :doc:`Airflow Plugin </authoring-and-scheduling/plugins>`
+To include the listener in your Airflow installation, include it as a part of an :doc:`Airflow Plugin </authoring-and-scheduling/plugins>`.
Listener API is meant to be called across all DAGs and all operators. You can't listen to events generated by specific DAGs. For that behavior, try methods like ``on_success_callback`` and ``pre_execute``. These provide callbacks for particular DAG authors or operator creators. The logs and ``print()`` calls will be handled as part of the listeners.
-
-
-|experimental|
diff --git a/newsfragments/1234.significant.rst b/newsfragments/1234.significant.rst
new file mode 100644
index 0000000000..7ecd81ad00
--- /dev/null
+++ b/newsfragments/1234.significant.rst
@@ -0,0 +1,18 @@
+Since Airflow 2.9.0, following Listener API methods are not considered experimental anymore:
+
+Lifecycle events:
+
+- ``on_starting``
+- ``before_stopping``
+
+DagRun State Change Events:
+
+- ``on_dag_run_running``
+- ``on_dag_run_success``
+- ``on_dag_run_failed``
+
+TaskInstance State Change Events:
+
+- ``on_task_instance_running``
+- ``on_task_instance_success``
+- ``on_task_instance_failed``