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

Establish logging pattern for non-critical failures #5288

Closed
wemeetagain opened this issue Mar 21, 2023 · 3 comments
Closed

Establish logging pattern for non-critical failures #5288

wemeetagain opened this issue Mar 21, 2023 · 3 comments
Labels
scope-logging Issue about logs: hygiene, format issues, improvements. scope-ux Issues for CLI UX or general consumer UX.

Comments

@wemeetagain
Copy link
Member

wemeetagain commented Mar 21, 2023

@wemeetagain I want to establish this pattern that for non-critical issues we use the terms "failed" and "reason" instead of "error" as based on my observations the term "error" scares a lot of users, especially less technical ones.

Originally posted by @nflaig in #5285 (comment)

@nflaig nflaig added scope-logging Issue about logs: hygiene, format issues, improvements. scope-ux Issues for CLI UX or general consumer UX. meta-discussion Indicates a topic that requires input from various developers. labels Mar 21, 2023
@philknows
Copy link
Member

Also some backlogged things we've wanted to get to in regards to UX on #4400. In my opinion, generally, the word error: should be reserved for issues where a user misconfiguration or inaction by the user created a problem. Thus, it should only be used as a way to prompt users that they must do something to rectify it.

If it's not something a normal user can fix, it should be more of a warning type of message or something where stacktrace can be logged elsewhere but not saturate the CLI with endless errors a typical user cannot do much with.

@philknows
Copy link
Member

Related to #5299 to set a standard

@philknows philknows removed the meta-discussion Indicates a topic that requires input from various developers. label Apr 12, 2023
@philknows philknows modified the milestone: v1.9.0 Apr 12, 2023
@philknows
Copy link
Member

Closed in favour of #5359

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope-logging Issue about logs: hygiene, format issues, improvements. scope-ux Issues for CLI UX or general consumer UX.
Projects
None yet
Development

No branches or pull requests

3 participants