You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PII (Personal Identifiable Information) has to be deletable at any point in time. Logging this kind of information out would force us to delete our logs or have complex log sanitation processes, and Logs should be "write only" in the first place anyway.
In general, it is a good idea to remove any and all non critical log statements.
A good log statement has the following properties:
Understandable, i.e. it provides enough information to make sense by itself. Example "New game session :id started", counter example (some component logging out some prop on its own) "3"
It enables us to understand system behavior. Example "Game :id failed to start - :reason", counter example "It is now :time".
It is not noisy. Logging always has to balance verbosity versus noise. It is easy to be tempted to just "log everything", but "logging everything" can be just as bad as "logging nothing", because the sheer amount of data makes it impossible to actually understand the logs
It is understandable that for debugging reasons one might want to add more verbose logs. One option is to put such logs behind feature flags, pipeline enforcement, or proper care during reviews.
The text was updated successfully, but these errors were encountered:
Hey @VoidedName, I started work implementing a logging level system as I noticed console.log's were getting pushed to the repo and making their way to production. Of course, as a side effect that somewhat touches on this tickets statement on logging too much vs too little.
I'll make a branch and throw a link in here for further discussion?
Task Summary
related to: #246
PII (Personal Identifiable Information) has to be deletable at any point in time. Logging this kind of information out would force us to delete our logs or have complex log sanitation processes, and Logs should be "write only" in the first place anyway.
In general, it is a good idea to remove any and all non critical log statements.
A good log statement has the following properties:
It is understandable that for debugging reasons one might want to add more verbose logs. One option is to put such logs behind feature flags, pipeline enforcement, or proper care during reviews.
The text was updated successfully, but these errors were encountered: