[GitHub] [airflow] pgagnon commented on a change in pull request #5407: [AIRFLOW-4741] Include Sentry into core Airflow

[GitBox <gi...@apache.org>]

pgagnon commented on a change in pull request #5407: [AIRFLOW-4741] Include Sentry into core Airflow
URL: https://github.com/apache/airflow/pull/5407#discussion_r318069432
 
 

 ##########
 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 <https://docs.sentry.io/>`__.
+
+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}'``
 
 Review comment:
   I think you could rephrase this. It's not immediately clear to me reading this how to actually configure this integration.
   
   I would suggest explicitely naming the actual configuration properties to be filled (`sentry_dsn`) in `airflow.cfg`, and adding an example DSN with dummy values.

----------------------------------------------------------------
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