nathan-contino commented on code in PR #28450: URL: https://github.com/apache/airflow/pull/28450#discussion_r1052327168
########## docs/apache-airflow/administration-and-deployment/listeners.rst: ########## @@ -18,43 +18,59 @@ Listeners ========= -Airflow gives you an option to be notified of events happening in Airflow -by writing listeners. Listeners are powered by `pluggy <https://pluggy.readthedocs.io/en/stable/>`__ +You can write listeners to enable Airflow to notify you when events happen. +`Pluggy <https://pluggy.readthedocs.io/en/stable/>`__ powers these listeners. -Right now Airflow exposes few types of events. +Airflow supports notifications for the following events: -Lifecycle events -^^^^^^^^^^^^^^^^ -Those events - ``on_starting`` and ``before_stopping`` allow you to react to -lifecycle to an Airflow ``Job``, like ``SchedulerJob`` or ``BackfillJob``. +Lifecycle Events +---------------- -TaskInstance state change events -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Those events - ``on_task_instance_running``, ``on_task_instance_success`` and ``on_task_instance_failed`` -once ``TaskInstance`` state changes to one of the respective states. This generally happens on ``LocalTaskJob``. +- ``on_starting`` +- ``before_stopping`` -DagRun state change events -^^^^^^^^^^^^^^^^^^^^^^^^^^ -Those events - ``on_dag_run_running``, ``on_dag_run_success`` and ``on_dag_run_failed`` -once ``DagRun`` state changes to one of the respective states. This generally happens on ``SchedulerJob`` or ``BackfillJob``. +Lifecycle events allow you to react to start and stop events for an Airflow ``Job``, like ``SchedulerJob`` or ``BackfillJob``. + +TaskInstance State Change Events +-------------------------------- + +- ``on_task_instance_running`` +- ``on_task_instance_success`` +- ``on_task_instance_failed`` + +TaskInstance state change events occur when a ``TaskInstance`` changes state. +You can use these events to react to ``LocalTaskJob`` state changes. + +DagRun State Change Events +-------------------------- + +- ``on_dag_run_running`` +- ``on_dag_run_success`` +- ``on_dag_run_failed`` + +DagRun state change events occur when a ``DagRun`` changes state. +You can use these events to react to ``SchedulerJob`` or ``BackfillJob`` state changes. Review Comment: Woah! Open to ideas here, then. For now I'll remove the DagRun section, we can always restore it if these events do actually exist. -- 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: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
