orcasound/orcaal

Improve logging utilities

Open

#32 opened on Jul 19, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (7 forks)auto 404
good first issue

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the logging in the repository mostly uses print statements, an example which can be seen here. While this is useful, we want something more robust in the long run that can be more informative about the kind of bugs/errors that we might face. Improve the logging across all the backend services by using a dedicated logging library.

Contributor guide

Research direction
Examine the current print statements and select a logging library (e.g., winston, pino) and integrate it consistently across backend services.
Tech stack
typescript
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80