Skip to content

Commit

Permalink
Update error message to guide the user into self-help mostly (#17929)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
potiuk authored Aug 31, 2021
1 parent 3fc57de commit 2aa443f
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion airflow/www/templates/airflow/traceback.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,24 @@ <h1> Ooops! </h1>
<div>
<pre>
Something bad has happened.
Please consider letting us know by creating a <b><a href="https://github.com/apache/airflow/issues/new/choose">bug report using GitHub</a></b>.

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:
* <b><a href="https://github.com/apache/airflow/discussions">GitHub Discussions</a></b>
* <b><a href="https://github.com/apache/airflow/issues">GitHub Issues</a></b>
* <b><a href="https://stackoverflow.com/questions/tagged/airflow">Stack Overflow</a></b>
* 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 <b><a href="https://github.com/apache/airflow/issues/new/choose">bug report</a></b>.
Make sure however, to include all relevant details and results of your investigation so far.

Python version: {{ python_version }}
Airflow version: {{ airflow_version }}
Expand Down

0 comments on commit 2aa443f

Please sign in to comment.