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

[TASK]: Make sure that no PII data is ever logged. And logging in general for that matter... #247

Open
VoidedName opened this issue Jul 15, 2023 · 2 comments

Comments

@VoidedName
Copy link
Collaborator

VoidedName commented Jul 15, 2023

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:

  • 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.

@FragAverage
Copy link
Contributor

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?

@VoidedName
Copy link
Collaborator Author

@FragAverage Sure. Technically this is a subtask of this, but yea, go ahead.

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

No branches or pull requests

2 participants