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

Make failure error more obvious #691

Merged
merged 2 commits into from
May 23, 2024

Conversation

stefnestor
Copy link
Contributor

👋 howdy, team!

We have users uploading empty (other than diagnostics.log) diagnostics to Support. AFAICT most come via the Fatal error occurred code path. This PR updates light console formatting to make this failure more obvious to users unfamiliar with our diagnostic (via a line-break and all-caps) so that they can rectify errors before uploading to reduce resolution time.

TIA! 🙏

@stefnestor stefnestor requested a review from a team as a code owner May 7, 2024 21:15
@stefnestor
Copy link
Contributor Author

stefnestor commented May 7, 2024

Also noting if only a handful of API calls fail for HTTP 403 reasons that error is much more apparent & could be considered here as well, e.g.

************************************************************
************************************************************
************************************************************
The elasticsearch user entered: elastic does not appear to have sufficient authorization to access all collected information
Some of the calls may not have completed successfully.
If you are using a custom role please verify that it has the admin role for versions prior to 5.x or the superuser role for subsequent versions.
************************************************************
************************************************************
************************************************************

Copy link
Member

@pickypg pickypg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although I'm going to remove the leading \n as that type of logging is incompatible if we ever switch to JSON logging.

@pickypg pickypg merged commit 639ce9e into elastic:main May 23, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants