mit-pdos/noria

Improve logging consistency throughout the codebase

Open

#89 opened on Sep 19, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (4,576 stars) (229 forks)batch import
enhancementgood first issuehelp wanted

Description

Currently, logging is pretty ad-hoc: different modules use logging levels pretty arbitrarily, and there is important information in trace levels and unimportant info in log. We should take a pass on the code base and figure out what information we usually end up wanting, what information we want for debugging purposes, and what we never even look at.

Contributor guide

Tech stack
rust
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with Rustunderstanding of Noria's architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by examining the logging usage across the codebase, identifying patterns and inconsistencies. The existing comments may provide insight into what logs are useful. Consider proposing a logging convention based on the project's needs, and then systematically update modules. Refer to the discussion in https://github.com/mit pdos/noria/issues/89 for more context.