AcademySoftwareFoundation / AcademySoftwareFoundation/rez

Review and clean up logging system

Open
#542 0 comments 0 reactions 0 assignees View on GitHub
difficulty/hard enhancement logging
Dominant language
Python
Stars
1.1k
Forks
369
Avg merge
12d 3h
Merged PRs (30d)
5

Description

Rez uses a mix of traditional logs using the `logging` library and print statements. It's quite a mess. This issue tracks the work needed to revamp our logging.

* Replace all the debug_xxx stuff with standard python loggers, which just have their levels set based on each `debug_xxx` config setting.
* https://rez.readthedocs.io/en/stable/configuring_rez.html#debugging
* https://rez.readthedocs.io/en/stable/configuring_rez.html#quiet
* https://rez.readthedocs.io/en/stable/configuring_rez.html#show_progress
* Handle log colors: https://rez.readthedocs.io/en/stable/configuring_rez.html#colorization
* A library like [rich](https://rich.readthedocs.io/en/latest/) could be helpful.

One thing to be careful with is that we probably don't want to introduce breaking changes to the output just yet, unless necessary.

Before starting to write/rewrite code, please provide a plan as this is a central part of rez and it will save time for both you and maintainers if we align on a solution before starting to implement anything.

Related issues: https://github.com/AcademySoftwareFoundation/rez/issues?q=is%3Aissue%20state%3Aopen%20label%3Alogging

Contributor guide

Open the contributing guide

Research direction

No source files or tests are named. Start by tracing the debug_xxx settings documented under debugging, quiet, show_progress, and colorization, then inventory the logging-library and print usage. The first deliverable is a maintainer-approved plan that avoids output changes unless necessary; implementation is complete when the logging behavior and color handling are consistently covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
observability, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.