Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the error message displayed when there is a webserver error #36570

Merged
merged 1 commit into from
Jan 3, 2024

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jan 3, 2024

The error message displayed when errors happen in the webserver did not properly communicate, that the user MUST look at the logs and provide more information to investigate the root cause (after looking at the logs themselves). We have a number of users just copy&pasting the generic error message without understanding that this is not nearly enough to help them.

This PR proposes a bit more explicit call to look at the logs and explains why details are not displayed (for security reasons).


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

The error message displayed when errors happen in the webserver did
not properly communicated, that the user MUST look at the logs and
provide more information to investigate the root cause (after looking
at the logs themselves). We have a number of users just copy&pasting
the generic error message without understanding that this is not nearly
enough to help them.

This PR proposes a bit more explicit call to look at the logs and
explains why details are not displayed (for security reasons).
@boring-cyborg boring-cyborg bot added area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues labels Jan 3, 2024
@potiuk potiuk requested a review from kaxil January 3, 2024 21:12
@potiuk potiuk added this to the Airflow 2.8.1 milestone Jan 3, 2024
@potiuk potiuk merged commit 574f86e into apache:main Jan 3, 2024
50 checks passed
@potiuk potiuk deleted the improve-error-message branch January 3, 2024 22:53
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Jan 10, 2024
ephraimbuddy pushed a commit that referenced this pull request Jan 11, 2024
…36570)

The error message displayed when errors happen in the webserver did
not properly communicated, that the user MUST look at the logs and
provide more information to investigate the root cause (after looking
at the logs themselves). We have a number of users just copy&pasting
the generic error message without understanding that this is not nearly
enough to help them.

This PR proposes a bit more explicit call to look at the logs and
explains why details are not displayed (for security reasons).

(cherry picked from commit 574f86e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants