Skip to content

Commit 14ac2e7

Browse files
aman2304dsikka
andauthored
[BugFix] Fix logging disabling bug and add tests (#1218)
SUMMARY: Fixed logging and clear loggers enabling/disabling bug. Previously, any value on the right environment variables would disable logging. Now, we explicitly check for `true` TEST PLAN: Added unit tests for enabling logging. `make test` passes --------- Signed-off-by: Aman Gupta <[email protected]> Co-authored-by: Dipika Sikka <[email protected]>
1 parent 8fc6012 commit 14ac2e7

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

src/llmcompressor/logger.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ class LoggerConfig:
5353
metrics_disabled: bool = False
5454

5555

56-
def configure_logger(config: Optional[LoggerConfig] = None):
56+
def configure_logger(config: Optional[LoggerConfig] = None) -> None:
5757
"""
58-
Configure the metrics for LLM Compressor.
58+
Configure the logger for LLM Compressor.
5959
This function sets up the console and file logging
6060
as per the specified or default parameters.
6161
@@ -68,9 +68,9 @@ def configure_logger(config: Optional[LoggerConfig] = None):
6868

6969
# env vars get priority
7070
if (disabled := os.getenv("LLM_COMPRESSOR_LOG_DISABLED")) is not None:
71-
logger_config.disabled = disabled.lower()
71+
logger_config.disabled = disabled.lower() == "true"
7272
if (clear_loggers := os.getenv("LLM_COMPRESSOR_CLEAR_LOGGERS")) is not None:
73-
logger_config.clear_loggers = clear_loggers.lower()
73+
logger_config.clear_loggers = clear_loggers.lower() == "true"
7474
if (console_log_level := os.getenv("LLM_COMPRESSOR_LOG_LEVEL")) is not None:
7575
logger_config.console_log_level = console_log_level.upper()
7676
if (log_file := os.getenv("LLM_COMPRESSOR_LOG_FILE")) is not None:

tests/unit/test_logger.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,16 @@ def test_environment_variable_disable_logging(monkeypatch, capsys):
103103
captured = capsys.readouterr()
104104
assert captured.out == ""
105105
assert captured.err == ""
106+
107+
108+
def test_environment_variable_enable_logging(monkeypatch, capsys):
109+
# Test environment variable to enable logging
110+
monkeypatch.setenv("LLM_COMPRESSOR_LOG_DISABLED", "false")
111+
112+
configure_logger(config=LoggerConfig())
113+
logger.info("Info message")
114+
logger.error("Error message")
115+
116+
captured = capsys.readouterr()
117+
assert captured.out.count("Info message") == 1
118+
assert captured.out.count("Error message") == 1

0 commit comments

Comments
 (0)