You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/10/08 16:56:17 UTC

[GitHub] [airflow] john-jac opened a new pull request #18842: Add Callbacks Section to Logging & Monitoring

john-jac opened a new pull request #18842:
URL: https://github.com/apache/airflow/pull/18842


   Airflow users often ask for an easy way to monitor the success or failure of tasks and/or DAGs.  The use of callbacks, such as on_success_callback, helps users monitor DAG runs in an easily configurable way.
   
   This document provides an overview of available callbacks, linked to the relevant section in the Tasks document.  It also provides a simple example of calling a function on any task failure in the DAG, as well as a separate function that is called upon the success of the last task in the DAG.


-- 
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-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] john-jac commented on a change in pull request #18842: Add Callbacks Section to Logging & Monitoring

Posted by GitBox <gi...@apache.org>.
john-jac commented on a change in pull request #18842:
URL: https://github.com/apache/airflow/pull/18842#discussion_r725508189



##########
File path: docs/apache-airflow/logging-monitoring/callbacks.rst
##########
@@ -0,0 +1,75 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+
+Callbacks
+=========
+
+A valuable component of logging and monitoring is the use of task callbacks to act upon changes in state of a given task, or across all tasks in a given DAG.
+For example, you may wish to alert when certain tasks have failed, or have the last task in your DAG invoke a callback when it succeeds.
+

Review comment:
       Thanks Jarek!  I've added a note indicating that callback functions are not invoked in the case of state change from UI or CLI.




-- 
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-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] potiuk commented on a change in pull request #18842: Add Callbacks Section to Logging & Monitoring

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #18842:
URL: https://github.com/apache/airflow/pull/18842#discussion_r725458778



##########
File path: docs/apache-airflow/logging-monitoring/callbacks.rst
##########
@@ -0,0 +1,75 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+
+Callbacks
+=========
+
+A valuable component of logging and monitoring is the use of task callbacks to act upon changes in state of a given task, or across all tasks in a given DAG.
+For example, you may wish to alert when certain tasks have failed, or have the last task in your DAG invoke a callback when it succeeds.
+

Review comment:
       Really Nice! I think we should however add better description of some 'unexpected' callback behaviours. Namely, that callbacks are not executed when the task status is manually set to failed/succeeded from teh UI/CLI. We've had a number of people complaining about it, but this is really an architectural decision (we cannot run callback in those cases because we have no worker which would run those callbacks at the moment we set the status).
   
    It woudl be great to add this here.




-- 
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-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] kaxil merged pull request #18842: Add Callbacks Section to Logging & Monitoring

Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #18842:
URL: https://github.com/apache/airflow/pull/18842


   


-- 
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-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [airflow] github-actions[bot] commented on pull request #18842: Add Callbacks Section to Logging & Monitoring

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #18842:
URL: https://github.com/apache/airflow/pull/18842#issuecomment-939326852


   The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.


-- 
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-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org