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

[Logging] Add a foundation for logging in path #5

Open
7 tasks
Olshansk opened this issue Sep 4, 2024 · 0 comments
Open
7 tasks

[Logging] Add a foundation for logging in path #5

Olshansk opened this issue Sep 4, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Olshansk
Copy link
Contributor

Olshansk commented Sep 4, 2024

Objective

Create a foundation for logging in this repo so we don't forget to add logs in subsequent work.

Origin Document

Screenshot 2024-09-04 at 1 58 16 PM

Goals

  • Encourage future PRs to add logging along the way
  • Have visibility into issues when they arise and be retroactive about having login in place

Deliverables

  • Choose a logger (e.g. zerolog, golang's default logger, poktroll's logger etc...)
  • Add a few log lines in different places in the existing code
  • Set a pattern on how to use the logger and context that will be referenced by others

Non-goals / Non-deliverables

  • Having a full-on observability pipeline in place
  • Being able to search or filter through logs

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @Olshansk
Co-Owners: @commoddity @adshmh

@Olshansk Olshansk added the enhancement New feature or request label Sep 4, 2024
@Olshansk Olshansk added this to the Path MVP milestone Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants