Skip to content

[Telemetry] Design shared logging module #164

@Olshansk

Description

@Olshansk

Objective

Create the foundations to unify and standardize the logging approach across the entire codebase.

Origin Document

See the github discussion for full details: #214

The implementation of this was started by @derrandz here: #162.

This ticket can either build on top of the existing WIP or use those learnings and apply them to a different approach.

Goals / Deliverables

  • Research and identify common logging frameworks available in Go and use in major codebases (e.g. Uber)
  • Design a new shared logging module based on the results from the research above. This means it could be:
    • Created from scratch
    • Imports an existing framework
    • Extends an existing one with a lightweight wrapper

General issue checklist

  • Update the appropriate CHANGELOG
  • Update the appropriate README on how to use and test this feature
  • Update any relevant global documentation & references
  • Add a video and/or gif on how to use feature
  • Document small issues / TODOs along the way

Non-goals

  • Add new logs throughout the codebase
  • Improve the explicitness or correctness of existing logs
  • Add new business logic functionality

Testing Methodology

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md
    Remove

Creator: @Olshansk
Co-Owners: @vlad-she @derrandz

Metadata

Metadata

Assignees

Labels

code healthNice to have code improvementcommunityOpen to or owned by a non-core team membercoreCore infrastructure - protocol relatedtelemetryeverything related to collection telemetrytoolingtooling to support development, testing et al

Type

No type
No fields configured for issues without a type.

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions