Skip to content

[Tooling] Implement a TODO method for the logging module #478

@Gustavobelfort

Description

@Gustavobelfort

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

Screenshot 2023-01-30 at 6 59 45 PM

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 LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @Gustavobelfort
Co-Owners: @Olshansk

Metadata

Metadata

Assignees

No one assigned

    Labels

    code healthNice to have code improvementcommunityOpen to or owned by a non-core team membercore starter taskGood for newcomers, but aimed at core team members though still open for everyonetoolingtooling to support development, testing et al

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions