Nautobot Plugin Nornir Logger

nautobot_plugin_nornir.logger

Custom logger to support writing to console and db.

DebugLoggingMixin

Job mixin to only record debug log messages when the job's debug input is enabled.

Nautobot sets job loggers to DEBUG so that every message reaches the job result. This mixin sets the job logger to DEBUG or INFO from the debug job input before the job runs, and restores the original level afterwards. List it before Job in the job's bases, and pass self.logger.getEffectiveLevel() to NornirLogger so Nornir plays follow the same level.

Source code in nautobot_plugin_nornir/logger.py

class DebugLoggingMixin:  # pylint: disable=too-few-public-methods
    """Job mixin to only record debug log messages when the job's `debug` input is enabled.

    Nautobot sets job loggers to `DEBUG` so that every message reaches the job result. This mixin sets the job
    logger to `DEBUG` or `INFO` from the `debug` job input before the job runs, and restores the original level
    afterwards. List it before `Job` in the job's bases, and pass `self.logger.getEffectiveLevel()` to
    `NornirLogger` so Nornir plays follow the same level.
    """

    def before_start(self, task_id, args, kwargs):
        """Set the job logger level from the `debug` input."""
        # The job logger is shared by every job in its module within a worker process, so `after_return` restores it.
        self._original_log_level = self.logger.level  # pylint: disable=attribute-defined-outside-init
        super().before_start(task_id, args, kwargs)
        self.logger.setLevel(logging.DEBUG if kwargs.get("debug") else logging.INFO)

    def after_return(self, status, retval, task_id, args, kwargs, einfo):  # pylint: disable=too-many-arguments
        """Restore the job logger level saved in `before_start`."""
        self.logger.setLevel(self._original_log_level)
        super().after_return(status, retval, task_id, args, kwargs, einfo)

after_return(status, retval, task_id, args, kwargs, einfo)

Restore the job logger level saved in before_start.

Source code in nautobot_plugin_nornir/logger.py

def after_return(self, status, retval, task_id, args, kwargs, einfo):  # pylint: disable=too-many-arguments
    """Restore the job logger level saved in `before_start`."""
    self.logger.setLevel(self._original_log_level)
    super().after_return(status, retval, task_id, args, kwargs, einfo)

before_start(task_id, args, kwargs)

Set the job logger level from the debug input.

Source code in nautobot_plugin_nornir/logger.py

def before_start(self, task_id, args, kwargs):
    """Set the job logger level from the `debug` input."""
    # The job logger is shared by every job in its module within a worker process, so `after_return` restores it.
    self._original_log_level = self.logger.level  # pylint: disable=attribute-defined-outside-init
    super().before_start(task_id, args, kwargs)
    self.logger.setLevel(logging.DEBUG if kwargs.get("debug") else logging.INFO)

NornirLogger

Logger that handles same signature as standard Python Library logging but also write to db.

Source code in nautobot_plugin_nornir/logger.py

class NornirLogger:
    """Logger that handles same signature as standard Python Library logging but also write to db."""

    def __init__(self, job_result, log_level: int):
        """Initialize the object."""
        self.job_result = job_result
        LOGGER.setLevel(log_level)

    def _logging_helper(self, attr: str, message: str, extra: Any = None):
        """Logger helper to set both db and console logs at once."""
        if not LOGGER.isEnabledFor(getattr(logging, attr.upper())):
            return
        if not extra:
            extra = {}
        getattr(LOGGER_ADAPTER, attr)(message, extra=extra)
        self.job_result.log(message, level_choice=attr, obj=extra.get("object"), grouping=extra.get("grouping", "main"))

    def debug(self, message: str, extra: Any = None):
        """Match standard Python Library debug signature."""
        self._logging_helper("debug", message, extra)

    def info(self, message: str, extra: Any = None):
        """Match standard Python Library info signature."""
        self._logging_helper("info", message, extra)

    def warning(self, message: str, extra: Any = None):
        """Match standard Python Library warning signature."""
        self._logging_helper("warning", message, extra)

    def error(self, message: str, extra: Any = None):
        """Match standard Python Library error signature."""
        self._logging_helper("error", message, extra)

    def critical(self, message: str, extra: Any = None):
        """Match standard Python Library critical signature."""
        self._logging_helper("critical", message, extra)

__init__(job_result, log_level)

Initialize the object.

Source code in nautobot_plugin_nornir/logger.py

def __init__(self, job_result, log_level: int):
    """Initialize the object."""
    self.job_result = job_result
    LOGGER.setLevel(log_level)

critical(message, extra=None)

Match standard Python Library critical signature.

Source code in nautobot_plugin_nornir/logger.py

def critical(self, message: str, extra: Any = None):
    """Match standard Python Library critical signature."""
    self._logging_helper("critical", message, extra)

debug(message, extra=None)

Match standard Python Library debug signature.

Source code in nautobot_plugin_nornir/logger.py

def debug(self, message: str, extra: Any = None):
    """Match standard Python Library debug signature."""
    self._logging_helper("debug", message, extra)

error(message, extra=None)

Match standard Python Library error signature.

Source code in nautobot_plugin_nornir/logger.py

def error(self, message: str, extra: Any = None):
    """Match standard Python Library error signature."""
    self._logging_helper("error", message, extra)

info(message, extra=None)

Match standard Python Library info signature.

Source code in nautobot_plugin_nornir/logger.py

def info(self, message: str, extra: Any = None):
    """Match standard Python Library info signature."""
    self._logging_helper("info", message, extra)

warning(message, extra=None)

Match standard Python Library warning signature.

Source code in nautobot_plugin_nornir/logger.py

def warning(self, message: str, extra: Any = None):
    """Match standard Python Library warning signature."""
    self._logging_helper("warning", message, extra)