anti
4b15b7eb35
'sudo decnet deploy' needs root for MACVLAN, but the log files it creates (decnet.log and decnet.system.log) end up owned by root. A subsequent non-root 'decnet api' then crashes on PermissionError appending to them. New decnet.privdrop helper reads SUDO_UID/SUDO_GID and chowns files/dirs back to the invoking user. Best-effort: no-op when not root, not under sudo, path missing, or chown fails. Applied at both log-file creation sites (config.py system log, logging/file_handler.py syslog file).
72 lines
2.1 KiB
Python
72 lines
2.1 KiB
Python
"""
|
|
Rotating file handler for DECNET syslog output.
|
|
|
|
Writes RFC 5424 syslog lines to a local file.
|
|
Path is controlled by the DECNET_LOG_FILE environment variable
|
|
(default: /var/log/decnet/decnet.log).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import logging.handlers
|
|
import os
|
|
from pathlib import Path
|
|
|
|
from decnet.privdrop import chown_to_invoking_user, chown_tree_to_invoking_user
|
|
from decnet.telemetry import traced as _traced
|
|
|
|
_LOG_FILE_ENV = "DECNET_LOG_FILE"
|
|
_DEFAULT_LOG_FILE = "/var/log/decnet/decnet.log"
|
|
_MAX_BYTES = 10 * 1024 * 1024 # 10 MB
|
|
_BACKUP_COUNT = 5
|
|
|
|
_handler: logging.handlers.RotatingFileHandler | None = None
|
|
_logger: logging.Logger | None = None
|
|
|
|
|
|
@_traced("logging.init_file_handler")
|
|
def _init_file_handler() -> logging.Logger:
|
|
"""One-time initialisation of the rotating file handler."""
|
|
global _handler, _logger
|
|
|
|
log_path = Path(os.environ.get(_LOG_FILE_ENV, _DEFAULT_LOG_FILE))
|
|
log_path.parent.mkdir(parents=True, exist_ok=True)
|
|
# When running under sudo, hand the parent dir back to the invoking user
|
|
# so a subsequent non-root `decnet api` can also write to it.
|
|
chown_tree_to_invoking_user(log_path.parent)
|
|
|
|
_handler = logging.handlers.RotatingFileHandler(
|
|
log_path,
|
|
maxBytes=_MAX_BYTES,
|
|
backupCount=_BACKUP_COUNT,
|
|
encoding="utf-8",
|
|
)
|
|
chown_to_invoking_user(log_path)
|
|
_handler.setFormatter(logging.Formatter("%(message)s"))
|
|
|
|
_logger = logging.getLogger("decnet.syslog")
|
|
_logger.setLevel(logging.DEBUG)
|
|
_logger.propagate = False
|
|
_logger.addHandler(_handler)
|
|
|
|
return _logger
|
|
|
|
|
|
def _get_logger() -> logging.Logger:
|
|
if _logger is not None:
|
|
return _logger
|
|
return _init_file_handler()
|
|
|
|
|
|
def write_syslog(line: str) -> None:
|
|
"""Write a single RFC 5424 syslog line to the rotating log file."""
|
|
try:
|
|
_get_logger().info(line)
|
|
except Exception: # nosec B110
|
|
pass
|
|
|
|
def get_log_path() -> Path:
|
|
"""Return the configured log file path (for tests/inspection)."""
|
|
return Path(os.environ.get(_LOG_FILE_ENV, _DEFAULT_LOG_FILE))
|