Standardise logging, error message formatting,wrapping etc across codebase
- Dominant language
- Go
- Stars
- 1.6k
- Forks
- 617
- Avg merge
- 5d 10h
- Merged PRs (30d)
- 43
Description
### Describe the feature you'd like to have #
Standardised logging, error message formatting,wrapping etc across code base.
Currently, we use a variety of logging (Info,Debug,Error) and error formatting (`"failed with ... with err %w"` , `"failed with ... : %w"` ).
Its good to document these and keep it uniform across codebase.
### How will we know we have a good solution? (acceptance criteria)
- Standard documented format used across code base.
#### Add a list of criteria that should be met for this feature to be useful
- Ease of interpretation error/log messages and implementation.
- Consensus and acceptance of the standardised format.
Please comment your suggestions below.
cc @nixpanic @yati1998
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the existing logging calls and error-formatting patterns across the codebase, then read the issue discussion for proposed conventions. Done means a documented standard is agreed on and the codebase follows the accepted logging and error-message format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100