-
Notifications
You must be signed in to change notification settings - Fork 33
Closed
Labels
code healthNice to have code improvementNice to have code improvementcommunityOpen to or owned by a non-core team memberOpen to or owned by a non-core team membercore starter taskGood for newcomers, but aimed at core team members though still open for everyoneGood for newcomers, but aimed at core team members though still open for everyonetoolingtooling to support development, testing et altooling to support development, testing et al
Milestone
Description
Objective
Add a TODO method to the logging module to improve our workflow.
This method would allow us to add a log message with a TODO tag, indicating that a task is not yet completed. The method would allow us to identify these tasks and prioritize them quickly.
Example Usage:
u.logger.TODO().Msg("Log message explaining the TODO")Origin Document
- The following comment from the PR that introduced logging in the codebase: [Telemetry] Apply shared logging module #420 (comment)
Goals
- Increase ease of adding and visibility of finding TODOs in our logs
- The TODO messages should be clearly distinguishable from other log messages
Deliverable
- TODO Method extending the zerolog api added to the logging module
- Updated documentation on how to use this
- Updating all printed TODOs in the code (not the comments) with this the new function
Non-goals / Non-deliverables
- Updating all the TODOs in the comments with a log message
- Adding new logs
General issue deliverables
- Update the appropriate CHANGELOG(s)
- Update any relevant local/global README(s)
Testing Methodology
- All tests:
make test_all - LocalNet: verify a
LocalNetis still functioning correctly by following the instructions at docs/development/README.md
Creator: @Gustavobelfort
Co-Owners: @Olshansk
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
code healthNice to have code improvementNice to have code improvementcommunityOpen to or owned by a non-core team memberOpen to or owned by a non-core team membercore starter taskGood for newcomers, but aimed at core team members though still open for everyoneGood for newcomers, but aimed at core team members though still open for everyonetoolingtooling to support development, testing et altooling to support development, testing et al
Type
Projects
Status
Done
