You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by we...@apache.org on 2024/09/03 02:56:03 UTC

(airflow) branch v2-10-test updated: Add warning that listeners can be dangerous (#41968)

This is an automated email from the ASF dual-hosted git repository.

weilee pushed a commit to branch v2-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/v2-10-test by this push:
     new c45d013f9f Add warning that listeners can be dangerous (#41968)
c45d013f9f is described below

commit c45d013f9feb87874f893c892bb5d05aa750edd0
Author: Wei Lee <we...@gmail.com>
AuthorDate: Tue Sep 3 10:55:55 2024 +0800

    Add warning that listeners can be dangerous (#41968)
    
    They are necessarily dangerous, but simply due to the way they are
    integrated into Airflow, their side effects can be pretty impactful.
    
    Co-authored-by: Jed Cunningham <je...@apache.org>
---
 docs/apache-airflow/administration-and-deployment/listeners.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/apache-airflow/administration-and-deployment/listeners.rst b/docs/apache-airflow/administration-and-deployment/listeners.rst
index a8dbda4c5d..34909e225a 100644
--- a/docs/apache-airflow/administration-and-deployment/listeners.rst
+++ b/docs/apache-airflow/administration-and-deployment/listeners.rst
@@ -21,6 +21,11 @@ Listeners
 You can write listeners to enable Airflow to notify you when events happen.
 `Pluggy <https://pluggy.readthedocs.io/en/stable/>`__ powers these listeners.
 
+.. warning::
+
+    Listeners are an advanced feature of Airflow. They are not isolated from the Airflow components they run in, and
+    can slow down or in come cases take down your Airflow instance. As such, extra care should be taken when writing listeners.
+
 Airflow supports notifications for the following events:
 
 Lifecycle Events