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

Review logging for 'noise' #16

Open
iancooper opened this issue Sep 5, 2018 · 3 comments
Open

Review logging for 'noise' #16

iancooper opened this issue Sep 5, 2018 · 3 comments

Comments

@iancooper
Copy link
Member

Darker may be a little noisy when logging. Brighter can be, but we tend to review and @holytshirt and I fight about what should be logged at a lower or higher level until we get some sort of consensus.

The trade-off is between diagnostically useful, and noise.

We should log something as WARN because it could become or trigger a fault
We should log something as ERROR because it is a fault, although we may take action in response.
We should log something as FATAL because something bad happened and we intend to fail fast. We rarely do this, because we don't control lifetime. Generally we ought to raise error and assume the host application decides our fault was fatal

We should INFO carefully. We used it a lot in the past for tracing but it made us noisy. We should be using it to help developers trace execution, indicating beginning and end of pipelines etc. . This level should help help folks see flow, but without the additional debug information If we have detail we should probably be DEBUG.

@colinangusmackay
Copy link

If I may add my tuppenny worth.

I feel that a library should mostly log at the DEBUG level. I don't expect to have to deal with the internal workings on a daily basis and our production services set the bar at INFO and above. For the most part, outwith development itself, I'm rarely (if ever) interested in the internal workings of a library such as Brighter or Darker, so INFO is too noisy in production, even if its just to say "I'm executing this command/query". If I do want that I have a decorator to log that kind of thing.

@holytshirt
Copy link
Member

Thanks hopefully get a chance to look at this soon

@iancooper
Copy link
Member Author

@holytshirt Feel free to pick up the ticket. No one is assigned

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants