From 2aa443f8d5f0fe9b4b37b9029e9bac5176c563ce Mon Sep 17 00:00:00 2001 From: Jarek Potiuk Date: Tue, 31 Aug 2021 10:15:30 +0200 Subject: [PATCH] Update error message to guide the user into self-help mostly (#17929) The error report generated, when there is a crash on webserver, directed the user to open an issue in Apache Airflow without any extra explanation or suggesting other actions. This is not a good idea because it might lead people to thinking that they can just follow the link, open issue and it will be solved, However, more often than not such issue can be caused by misconfiguration, networking or other actions that the user should - in many cases - be able to fix or workaround on their own, with a little effort of gathering logs/information and searching for relevant problems. This PR changes the message as folows: * explains that user should gather more information (the link and bug report does not contain any information) * search for similar problem (we provide links to the places which can be searched and suggest using regular search engine as well * direct the managed services users to open the issue using relevant channels * only as the last resort, opening an issue in Airflow GitHub, providing sufficient information. --- airflow/www/templates/airflow/traceback.html | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/airflow/www/templates/airflow/traceback.html b/airflow/www/templates/airflow/traceback.html index ef4a49864c48f..38ae50c21161a 100644 --- a/airflow/www/templates/airflow/traceback.html +++ b/airflow/www/templates/airflow/traceback.html @@ -28,7 +28,24 @@

Ooops! 

 Something bad has happened.
-Please consider letting us know by creating a bug report using GitHub.
+
+Airflow is used by many users, and it is very likely that others had similar problems and you can easily find
+a solution to your problem.
+
+Consider following those steps:
+
+  * gather the relevant information (detailed logs with errors, reproduction steps, details of your deployment)
+
+  * find similar issues using:
+     * GitHub Discussions
+     * GitHub Issues
+     * Stack Overflow
+     * the usual search engine you use on a daily basis
+
+  * if you run Airflow on a Managed Service, consider opening an issue using the service support channels
+
+  * if you tried and have difficulty with diagnosing and fixing the problem yourself, consider creating a bug report.
+    Make sure however, to include all relevant details and results of your investigation so far.
 
 Python version: {{ python_version }}
 Airflow version: {{ airflow_version }}