Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions alts/shared/utils/log_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,37 @@ def redact_secrets(text, secrets: Iterable[str] = ()):
return URL_CREDENTIALS_REGEX.sub(rf'\g<prefix>{REDACTED}@', text)


class RedactingFilter(logging.Filter):
"""
Logging filter that masks credentials in the records themselves.

Unlike RedactingFormatter it also covers handlers of the parent loggers
the records propagate to (e.g. the Celery worker log), since logger
filters run before any handler gets the record.
"""

def __init__(self, secrets: Iterable[str] = ()):
super().__init__()
self._secrets = list(secrets)
self._formatter = logging.Formatter()

def filter(self, record: logging.LogRecord) -> bool:
record.msg = redact_secrets(record.getMessage(), self._secrets)
record.args = ()
if record.exc_info and not record.exc_text:
record.exc_text = self._formatter.formatException(
record.exc_info,
)
if record.exc_text:
record.exc_text = redact_secrets(record.exc_text, self._secrets)
if record.stack_info:
record.stack_info = redact_secrets(
record.stack_info,
self._secrets,
)
return True


class RedactingFormatter(logging.Formatter):
"""
Logging formatter that masks credentials in the formatted records.
Expand Down
5 changes: 5 additions & 0 deletions alts/worker/runners/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
repo_reference_subpath,
)
from alts.shared.utils.log_utils import (
RedactingFilter,
RedactingFormatter,
check_for_error_string,
get_temp_log_files,
Expand Down Expand Up @@ -1730,6 +1731,10 @@ def init_test_task_logger(
"""
logger = logging.getLogger(f'test_task-{task_id}-{arch}-logger')
logger.handlers = []
# Records propagate to the root (Celery worker) logger,
# whose handlers don't use RedactingFormatter
logger.filters = []
logger.addFilter(RedactingFilter(secrets))
log_level = logging.DEBUG if verbose else logging.INFO
logger.setLevel(log_level)
formatter = RedactingFormatter(
Expand Down
34 changes: 34 additions & 0 deletions tests/shared/test_log_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

from alts.shared.utils.log_utils import (
REDACTED,
RedactingFilter,
RedactingFormatter,
prepare_secrets,
redact_secrets,
Expand Down Expand Up @@ -73,3 +74,36 @@ def test_redacting_formatter():
assert 'tok@' not in output
assert 'top-secret' not in output
assert f'https://alts:{REDACTED}@host/repo' in output


def test_redacting_filter_covers_parent_handlers():
# Parent handler with a plain formatter, like the Celery worker log
parent_stream = io.StringIO()
parent_handler = logging.StreamHandler(parent_stream)
parent_handler.setFormatter(logging.Formatter('%(message)s'))
parent = logging.getLogger('test-redacting-filter')
parent.handlers = [parent_handler]
parent.setLevel(logging.DEBUG)
parent.propagate = False

logger = logging.getLogger('test-redacting-filter.task')
logger.handlers = []
logger.filters = []
logger.addFilter(RedactingFilter(['top-secret']))
logger.setLevel(logging.DEBUG)

logger.error(
'Cannot install package %s: %s',
'foo',
'Status code: 503 for https://alts:tok@host/repodata/repomd.xml',
)
try:
raise RuntimeError('failed with top-secret')
except RuntimeError:
logger.exception('Unknown error')

output = parent_stream.getvalue()
assert 'tok@' not in output
assert 'top-secret' not in output
assert f'https://alts:{REDACTED}@host/repodata/repomd.xml' in output
assert f'RuntimeError: failed with {REDACTED}' in output
Loading