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

More descriptive error messages / error logging #77

Open
stevenrick opened this issue Jul 29, 2022 · 0 comments
Open

More descriptive error messages / error logging #77

stevenrick opened this issue Jul 29, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@stevenrick
Copy link
Member

When errors come up, people using the application may not understand why or know how to troubleshoot / debug the problem. Error messages should be descriptive and thorough enough to not only say what went wrong but also guess at why it went wrong. For example, if a video stream could not be opened, is that because it is open elsewhere?

Looking beyond this more human-centered description of the issue and how to troubleshoot/resolve it, there might still be utility in a more technical explanation of what is wrong. This could be moved to a more detailed and secondary error message (UI having some sort of expandable section for the smaller more detailed technical message).

Alternatively the application can dump technical messages to a log file and forego the front end entirely. This should be handled in an asynchronous and append-only manner so that should the application crash the logs not be corrupted, lost, or destroyed.

@stevenrick stevenrick added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant