Skip to content

Commit da3b4c1

Browse files
committed
fix(log): propagate to configured loggers without duplicate stderr
Stop forcing propagate=False on RedisVL loggers. The default stderr handler now no-ops when the application attached handlers on the root or a parent logger, so INFO/DEBUG and ancestor handlers work again while unconfigured WARNING+ output still reaches stderr without exc tracebacks.
1 parent 6a55dc7 commit da3b4c1

4 files changed

Lines changed: 67 additions & 9 deletions

File tree

‎redisvl/cli/migrate.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
from pathlib import Path
66
from typing import Optional
77

8-
from redisvl.cli.utils import add_redis_connection_options, create_redis_url, log_cli_exception
8+
from redisvl.cli.utils import (
9+
add_redis_connection_options,
10+
create_redis_url,
11+
log_cli_exception,
12+
)
913
from redisvl.migration import (
1014
AsyncMigrationExecutor,
1115
BatchMigrationExecutor,

‎redisvl/cli/utils.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
import json
2-
import logging
32
import os
43
from argparse import ArgumentParser, Namespace, _ArgumentGroup
54
from typing import Any, Mapping, Union
65
from urllib.parse import quote, urlparse, urlunparse
76

87
from redisvl.redis.constants import REDIS_URL_ENV_VAR
9-
from redisvl.utils.log import get_logger
8+
from redisvl.utils.log import _has_application_handlers, get_logger
109

1110
logger = get_logger("[RedisVL]")
1211
DEFAULT_REDIS_HOST = "localhost"
@@ -15,7 +14,7 @@
1514

1615
def log_cli_exception(exc: BaseException) -> None:
1716
"""Record a CLI failure when the host application configured logging."""
18-
if logging.getLogger().handlers:
17+
if _has_application_handlers(logger.name):
1918
logger.error(exc, exc_info=True)
2019

2120

‎redisvl/utils/log.py‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ def __init__(self) -> None:
1616
super().__init__(level=logging.WARNING)
1717

1818
def emit(self, record: logging.LogRecord) -> None:
19-
root = logging.getLogger()
20-
if root.handlers:
21-
root.handle(record)
19+
if _has_application_handlers(record.name):
2220
return
2321
clean = logging.makeLogRecord(
2422
{
@@ -31,6 +29,19 @@ def emit(self, record: logging.LogRecord) -> None:
3129
logging.lastResort.handle(clean)
3230

3331

32+
def _has_application_handlers(logger_name: str) -> bool:
33+
"""True when the host app attached handlers outside RedisVL's default."""
34+
root = logging.getLogger()
35+
if root.handlers:
36+
return True
37+
parts = logger_name.split(".")
38+
for i in range(len(parts), 0, -1):
39+
for handler in logging.getLogger(".".join(parts[:i])).handlers:
40+
if not isinstance(handler, _DefaultStderrHandler):
41+
return True
42+
return False
43+
44+
3445
def get_logger(name, log_level="info", fmt=None):
3546
"""Return a logger instance."""
3647

@@ -40,5 +51,4 @@ def get_logger(name, log_level="info", fmt=None):
4051
logger = logging.getLogger(name)
4152
if not any(isinstance(h, _DefaultStderrHandler) for h in logger.handlers):
4253
logger.addHandler(_DefaultStderrHandler())
43-
logger.propagate = False
4454
return logger

‎tests/unit/test_log.py‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def test_get_logger_attaches_default_stderr_handler():
4343
logger = get_logger(name)
4444
assert len(logger.handlers) == 1
4545
assert isinstance(logger.handlers[0], _DefaultStderrHandler)
46-
assert logger.propagate is False
46+
assert logger.propagate is True
4747

4848

4949
def test_warning_reaches_stderr_without_logging_configuration():
@@ -81,6 +81,51 @@ def test_error_with_exc_info_does_not_write_traceback_to_stderr():
8181
assert "Traceback" not in result.stderr
8282

8383

84+
def test_info_propagates_when_root_logging_is_configured_for_debug():
85+
result = _run("""
86+
import logging
87+
import sys
88+
89+
logging.basicConfig(
90+
stream=sys.stdout,
91+
format="APP %(levelname)s %(name)s %(message)s",
92+
level=logging.DEBUG,
93+
)
94+
from redisvl.utils.log import get_logger
95+
96+
get_logger("redisvl.demo").info("configured redisvl info")
97+
""")
98+
assert result.returncode == 0, result.stderr
99+
assert result.stdout.splitlines() == [
100+
"APP INFO redisvl.demo configured redisvl info"
101+
]
102+
assert "configured redisvl info" not in result.stderr
103+
104+
105+
def test_parent_logger_handlers_receive_redisvl_records():
106+
result = _run("""
107+
import logging
108+
import sys
109+
110+
parent = logging.getLogger("redisvl")
111+
parent.setLevel(logging.INFO)
112+
parent.addHandler(
113+
logging.StreamHandler(sys.stdout)
114+
)
115+
parent.handlers[0].setFormatter(
116+
logging.Formatter("PARENT %(levelname)s %(name)s %(message)s")
117+
)
118+
from redisvl.utils.log import get_logger
119+
120+
get_logger("redisvl.demo").info("parent handler info")
121+
""")
122+
assert result.returncode == 0, result.stderr
123+
assert result.stdout.splitlines() == [
124+
"PARENT INFO redisvl.demo parent handler info"
125+
]
126+
assert "parent handler info" not in result.stderr
127+
128+
84129
def test_configured_logging_still_receives_redisvl_warnings():
85130
result = _run("""
86131
import logging

0 commit comments

Comments
 (0)