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.

Sign up for GitHub

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

Jump to bottom

Refine and standardise logs #127

Closed
raminqaf opened this issue Oct 19, 2022 · 0 comments · Fixed by #131
Closed

Refine and standardise logs #127

raminqaf opened this issue Oct 19, 2022 · 0 comments · Fixed by #131
Assignees
@DawidNiezgodka
Labels
type/refactor Refactoring of existing functionality
Milestone
Tracing and logging

Comments

@raminqaf
Copy link
Contributor

Currently, there are some problems regarding the logs in Quick:

  • Some of the logs in Quick are not useful and need to be rewritten to provide more useful information.
  • The log level (info, warn, debug, etc.) is not used properly. We should find a convention between the log levels.
  • Some parts of Quick are not logged at all.
@raminqaf raminqaf added the type/refactor Refactoring of existing functionality label Oct 19, 2022
@raminqaf raminqaf added this to the Tracing and logging milestone Oct 19, 2022
@DawidNiezgodka DawidNiezgodka mentioned this issue Oct 24, 2022
Merged
DawidNiezgodka added a commit that referenced this issue Nov 11, 2022
@DawidNiezgodka
Log refactoring + some minor code comments improvements (#131)
9db94fc 
Resolves #127 and resolves #133 and resolves #129.
The first attempt to impose some structure to our logging strategy in
Quick:

User-triggered interactions addressed by specific services are logged at
the level info.
Parameters of the methods + some internal mechanisms are on debug.
Detailed info is on trace.
log.error has been removed if an exception is immediately rethrown with
the same message.
Duplicates have been removed, i.e. service A calls B and logs "doing X",
and then a similar statement is in B.
Some logs statements that seemed irrelevant have been removed.
Moreover, some code comments have been corrected (grammar, spelling)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DawidNiezgodka DawidNiezgodka

Labels
type/refactor Refactoring of existing functionality
Projects
Quick
Status: Done
Milestone
Tracing and logging
Development

Successfully merging a pull request may close this issue.

Log refactoring + some minor code comments improvements bakdata/quick
2 participants
@raminqaf @DawidNiezgodka