Skip to content

Commit 149a8e6

Browse files
committed
fix(log,cli): keep stderr clean on CLI failures without hiding warnings
Attach a default stderr handler on get_logger loggers so unconfigured apps still see WARNING+ on stderr (redis#786) while exc_info does not dump tracebacks there. CLI exception handlers only log when the host app configured logging.
1 parent 0403b24 commit 149a8e6

7 files changed

Lines changed: 70 additions & 21 deletions

File tree

‎redisvl/cli/index.py‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
add_json_output_flag,
1111
cli_print_json,
1212
create_redis_url,
13+
log_cli_exception,
1314
)
1415
from redisvl.exceptions import RedisSearchError
1516
from redisvl.index import SearchIndex
@@ -20,9 +21,6 @@
2021
)
2122
from redisvl.redis.utils import convert_bytes
2223
from redisvl.schema.schema import IndexSchema
23-
from redisvl.utils.log import get_logger
24-
25-
logger = get_logger("[RedisVL]")
2624

2725
# Exceptions commonly raised when loading or validating a schema path (-s).
2826
SCHEMA_INPUT_ERRORS = (
@@ -83,7 +81,7 @@ def __init__(self):
8381
try:
8482
args.handler(args)
8583
except Exception as e:
86-
logger.error(e, exc_info=True)
84+
log_cli_exception(e)
8785
print(str(e), file=sys.stderr)
8886
sys.exit(1)
8987

‎redisvl/cli/migrate.py‎

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

8-
from redisvl.cli.utils import add_redis_connection_options, create_redis_url
8+
from redisvl.cli.utils import add_redis_connection_options, create_redis_url, log_cli_exception
99
from redisvl.migration import (
1010
AsyncMigrationExecutor,
1111
BatchMigrationExecutor,
@@ -74,7 +74,7 @@ def __init__(self):
7474
getattr(self, command)()
7575
except Exception as e:
7676
print(f"Error: {e}", file=sys.stderr)
77-
logger.error(e)
77+
log_cli_exception(e)
7878
sys.exit(1)
7979

8080
def helper(self):

‎redisvl/cli/stats.py‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,11 @@
1010
add_json_output_flag,
1111
cli_print_json,
1212
create_redis_url,
13+
log_cli_exception,
1314
)
1415
from redisvl.exceptions import RedisSearchError
1516
from redisvl.index import SearchIndex
1617
from redisvl.schema.schema import IndexSchema
17-
from redisvl.utils.log import get_logger
18-
19-
logger = get_logger("[RedisVL]")
2018

2119
# Exceptions commonly raised when loading or validating a schema path (-s).
2220
SCHEMA_INPUT_ERRORS = (
@@ -113,7 +111,7 @@ def __init__(self):
113111
try:
114112
self.stats(args)
115113
except Exception as e:
116-
logger.error(e, exc_info=True)
114+
log_cli_exception(e)
117115
print(str(e), file=sys.stderr)
118116
sys.exit(1)
119117

‎redisvl/cli/utils.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import json
2+
import logging
23
import os
34
from argparse import ArgumentParser, Namespace, _ArgumentGroup
45
from typing import Any, Mapping, Union
@@ -12,6 +13,12 @@
1213
DEFAULT_REDIS_PORT = 6379
1314

1415

16+
def log_cli_exception(exc: BaseException) -> None:
17+
"""Record a CLI failure when the host application configured logging."""
18+
if logging.getLogger().handlers:
19+
logger.error(exc, exc_info=True)
20+
21+
1522
def _has_explicit_connection_options(args: Namespace) -> bool:
1623
return any(
1724
(

‎redisvl/utils/log.py‎

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,44 @@
11
import logging
22

33

4-
def get_logger(name, log_level="info", fmt=None):
5-
"""Return a logger instance.
4+
class _DefaultStderrHandler(logging.Handler):
5+
"""Emit WARNING+ when the application has not configured logging.
66
7-
No handler is attached. A ``NullHandler`` counts as a handler and stops
8-
Python from sending WARNING and above to ``logging.lastResort`` (stderr)
9-
when the application has not configured logging.
7+
``NullHandler`` counts as a handler and prevents ``logging.lastResort``
8+
from running, which hid RedisVL warnings before #786. This handler forwards
9+
WARNING and above to stderr (via ``lastResort``) when the root logger has
10+
no handlers, and forwards to the root logger once logging is configured.
11+
Exception tracebacks are not written here so CLI code can log with
12+
``exc_info`` for configured apps without duplicating tracebacks on stderr.
1013
"""
1114

15+
def __init__(self) -> None:
16+
super().__init__(level=logging.WARNING)
17+
18+
def emit(self, record: logging.LogRecord) -> None:
19+
root = logging.getLogger()
20+
if root.handlers:
21+
root.handle(record)
22+
return
23+
clean = logging.makeLogRecord(
24+
{
25+
**record.__dict__,
26+
"exc_info": None,
27+
"exc_text": None,
28+
"stack_info": None,
29+
}
30+
)
31+
logging.lastResort.handle(clean)
32+
33+
34+
def get_logger(name, log_level="info", fmt=None):
35+
"""Return a logger instance."""
36+
1237
# Use file name if logger is in debug mode
1338
name = "RedisVL" if log_level == "debug" else name
1439

15-
return logging.getLogger(name)
40+
logger = logging.getLogger(name)
41+
if not any(isinstance(h, _DefaultStderrHandler) for h in logger.handlers):
42+
logger.addHandler(_DefaultStderrHandler())
43+
logger.propagate = False
44+
return logger

‎tests/unit/test_cli_index.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,3 +459,4 @@ def test_index_runtime_errors(
459459
assert exc_info.value.code == 1
460460
assert captured.out == ""
461461
assert captured.err != ""
462+
assert "Traceback" not in captured.err

‎tests/unit/test_log.py‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import sys
1010
import textwrap
1111

12-
from redisvl.utils.log import get_logger
12+
from redisvl.utils.log import _DefaultStderrHandler, get_logger
1313

1414

1515
def _run(script: str) -> subprocess.CompletedProcess[str]:
@@ -38,11 +38,12 @@ def normalize(line: str, name: str, message: str) -> str:
3838
)
3939

4040

41-
def test_get_logger_does_not_attach_a_handler():
42-
name = "redisvl.test.nohandler"
41+
def test_get_logger_attaches_default_stderr_handler():
42+
name = "redisvl.test.stderr_handler"
4343
logger = get_logger(name)
44-
assert logger.handlers == []
45-
assert logger.propagate is True
44+
assert len(logger.handlers) == 1
45+
assert isinstance(logger.handlers[0], _DefaultStderrHandler)
46+
assert logger.propagate is False
4647

4748

4849
def test_warning_reaches_stderr_without_logging_configuration():
@@ -65,6 +66,21 @@ def test_warning_reaches_stderr_without_logging_configuration():
6566
_same_handler_format(redis_line, plain_line)
6667

6768

69+
def test_error_with_exc_info_does_not_write_traceback_to_stderr():
70+
result = _run("""
71+
from redisvl.utils.log import get_logger
72+
73+
logger = get_logger("redisvl.cli.test")
74+
try:
75+
raise RuntimeError("cli failure")
76+
except RuntimeError as exc:
77+
logger.error(exc, exc_info=True)
78+
""")
79+
assert result.returncode == 0, result.stderr
80+
assert "cli failure" in result.stderr
81+
assert "Traceback" not in result.stderr
82+
83+
6884
def test_configured_logging_still_receives_redisvl_warnings():
6985
result = _run("""
7086
import logging

0 commit comments

Comments
 (0)