trailofbits/manticore

Refactor logging to allow for complete control when used as a library

Open

#1369 opened on Feb 8, 2019

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (3,469 stars) (481 forks)batch import
good first issuehelp wantedrefactor

Description

The logging system in manticore.utils.log currently makes global changes like setting the the logging logger class. At best, this hinders third party programs that use Manticore as a library to modify how Manticore logs things. At worst, this can actually break third party programs' loggers.

As a continuation of #688, refactor the logging framework to make it extensible when Manticore is used as a library.

Contributor guide

Tech stack
python
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 Python logging moduleUnderstanding of Manticore's logging structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate manticore/utils/log.py to understand current global logger class setting. Review issue #688 for previous discussion. Design a solution that allows third party customization without breaking existing loggers. Consider using a configurable logger class or dependency injection.