Add logging to diagnose bugs in production #1283
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Marcel Robitaille <[email protected]>
Make enabling/disabling the logging and changing the log level configurable from localStorage. This way, we can instruct users to enable logging even before loading any of our JavaScript. This is very useful to troubleshoot issues that prevent our page from loading properly. The buttons to enable logging would obviously not work in this case. Signed-off-by: Marcel Robitaille <[email protected]>
Signed-off-by: Marcel Robitaille <[email protected]>
Signed-off-by: Marcel Robitaille <[email protected]>
Collaborator
|
If possible please fix the issues with prettier and add a short section to the dev documentation on how to enable the logger. I have not tested the code though. |
Signed-off-by: Marcel Robitaille <[email protected]>
Signed-off-by: Marcel Robitaille <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1275
Add a logging library and make enabling/disabling the logging and changing the log level configurable from localStorage. This way, we can instruct users to enable logging even before loading any of our JavaScript. This is very useful to troubleshoot issues that prevent our page from loading properly. The buttons to enable logging would obviously not work in this case.
To enable logging, a user only has to run the following before loading the app/refreshing the page:
This will automatically be reset after 30 minutes so verbose logging is not enabled permanently for the user.
The log level is also configurable. For example:
I added some logs throughout the app, but I suspect we will flush this out as required. I also added some logs specific to troubleshooting #1257.
To add a log inside a Vue component, you only have to do:
To add a log outside a view component, you can do: