From commits-return-65013-archive-asf-public=cust-asf.ponee.io@airflow.apache.org Thu Sep 5 15:40:28 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id D13A6180656 for ; Thu, 5 Sep 2019 17:40:27 +0200 (CEST) Received: (qmail 76478 invoked by uid 500); 6 Sep 2019 00:10:12 -0000 Mailing-List: contact commits-help@airflow.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@airflow.apache.org Delivered-To: mailing list commits@airflow.apache.org Received: (qmail 76465 invoked by uid 99); 6 Sep 2019 00:10:12 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 06 Sep 2019 00:10:12 +0000 From: GitBox To: commits@airflow.apache.org Subject: [GitHub] [airflow] tiopi commented on a change in pull request #5407: [AIRFLOW-4741] Include Sentry into core Airflow Message-ID: <156769802716.10038.10832470076956010910.gitbox@gitbox.apache.org> Date: Thu, 05 Sep 2019 15:40:27 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit tiopi commented on a change in pull request #5407: [AIRFLOW-4741] Include Sentry into core Airflow URL: https://github.com/apache/airflow/pull/5407#discussion_r320077974 ########## File path: docs/errors.rst ########## @@ -0,0 +1,62 @@ +.. 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. + +Error Tracking +=============== + +Airflow can be set up to send errors to `Sentry `__. + +Setup +------ + +First you must install sentry requirement: + +.. code-block:: bash + + pip install 'apache-airflow[sentry]' + +Add your ``SENTRY_DSN`` to your configuration file e.g. ``airflow.cfg`` under ``[sentry]``. Its template resembles the following: ``'{PROTOCOL}://{PUBLIC_KEY}@{HOST}/{PROJECT_ID}'`` + +.. note:: + If this value is not provided, the SDK will try to read it from the ``SENTRY_DSN`` environment variable. + +Tags +----- + +=================================== ================================================================ +Name Description +=================================== ================================================================ +dag_id Dag name of the dag that failed +task_id Task name of the task that failed +execution_date Execution date when the task failed +operator Operator name of the task that failed +=================================== ================================================================ + +Breadcrumbs +------------ + +=================================== ==================================================================================================== +Name Description +=================================== ==================================================================================================== +upstream_tasks[dag_id] Dag ID of task that executed before failed task +upstream_tasks[task_id] Task ID of task that executed before failed task +upstream_tasks[execution_date] Execution date of task instance that executed before failed task Review comment: The dag_id, execution date should not be necessary here since they match with the respective tags. The execution date should be replaced by a tag that captures the exact time the operation happened. This is to know if a delay on a previous operator might be causing the current one to fail. Docs for breadcrumbs: https://docs.sentry.io/enriching-error-data/breadcrumbs/?platform=python. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: users@infra.apache.org With regards, Apache Git Services