REDROOM

Navigation

Breadcrumbs

/ / lib / python3.6 / site-packages / cloudinit

Create

Create File | Create Folder | Upload Files | Run Command

Preview: log.py Size: 5.47 KB

//lib/python3.6/site-packages/cloudinit/log.py

# Copyright (C) 2012 Canonical Ltd.
# Copyright (C) 2012 Hewlett-Packard Development Company, L.P.
# Copyright (C) 2012 Yahoo! Inc.
#
# Author: Scott Moser <scott.moser@canonical.com>
# Author: Juerg Haefliger <juerg.haefliger@hp.com>
# Author: Joshua Harlow <harlowja@yahoo-inc.com>
#
# This file is part of cloud-init. See LICENSE file for license information.

import collections.abc
import copy
import io
import logging
import logging.config
import logging.handlers
import os
import sys
import time
from collections import defaultdict
from contextlib import suppress
from typing import DefaultDict

DEFAULT_LOG_FORMAT = "%(asctime)s - %(filename)s[%(levelname)s]: %(message)s"
DEPRECATED = 35


def setup_basic_logging(level=logging.DEBUG, formatter=None):
    formatter = formatter or logging.Formatter(DEFAULT_LOG_FORMAT)
    root = logging.getLogger()
    console = logging.StreamHandler(sys.stderr)
    console.setFormatter(formatter)
    console.setLevel(level)
    root.addHandler(console)
    root.setLevel(level)


def flush_loggers(root):
    if not root:
        return
    for h in root.handlers:
        if isinstance(h, (logging.StreamHandler)):
            with suppress(IOError):
                h.flush()
    flush_loggers(root.parent)


def define_deprecation_logger(lvl=DEPRECATED):
    logging.addLevelName(lvl, "DEPRECATED")

    def deprecated(self, message, *args, **kwargs):
        if self.isEnabledFor(lvl):
            self._log(lvl, message, args, **kwargs)

    logging.Logger.deprecated = deprecated


def setup_logging(cfg=None):
    # See if the config provides any logging conf...
    if not cfg:
        cfg = {}

    root_logger = logging.getLogger()
    exporter = LogExporter()
    exporter.setLevel(logging.WARN)

    log_cfgs = []
    log_cfg = cfg.get("logcfg")
    if log_cfg and isinstance(log_cfg, str):
        # If there is a 'logcfg' entry in the config,
        # respect it, it is the old keyname
        log_cfgs.append(str(log_cfg))
    elif "log_cfgs" in cfg:
        for a_cfg in cfg["log_cfgs"]:
            if isinstance(a_cfg, str):
                log_cfgs.append(a_cfg)
            elif isinstance(a_cfg, (collections.abc.Iterable)):
                cfg_str = [str(c) for c in a_cfg]
                log_cfgs.append("\n".join(cfg_str))
            else:
                log_cfgs.append(str(a_cfg))

    # See if any of them actually load...
    am_tried = 0

    # log_cfg may contain either a filepath to a file containing a logger
    # configuration, or a string containing a logger configuration
    # https://docs.python.org/3/library/logging.config.html#logging-config-fileformat
    for log_cfg in log_cfgs:
        # The default configuration includes an attempt at using /dev/log,
        # followed up by writing to a file. /dev/log will not exist in
        # very early boot, so an exception on that is expected.
        with suppress(FileNotFoundError):
            am_tried += 1

            # If the value is not a filename, assume that it is a config.
            if not (log_cfg.startswith("/") and os.path.isfile(log_cfg)):
                log_cfg = io.StringIO(log_cfg)

            # Attempt to load its config.
            logging.config.fileConfig(log_cfg)

            # Configure warning exporter after loading logging configuration
            root_logger.addHandler(exporter)

            # Use the first valid configuration.
            return

    # Configure warning exporter for basic logging
    root_logger.addHandler(exporter)

    # If it didn't work, at least setup a basic logger (if desired)
    basic_enabled = cfg.get("log_basic", True)

    sys.stderr.write(
        "WARN: no logging configured! (tried %s configs)\n" % (am_tried)
    )
    if basic_enabled:
        sys.stderr.write("Setting up basic logging...\n")
        setup_basic_logging()


class LogExporter(logging.StreamHandler):
    holder: DefaultDict[str, list] = defaultdict(list)

    def emit(self, record: logging.LogRecord):
        self.holder[record.levelname].append(record.getMessage())

    def export_logs(self):
        return copy.deepcopy(self.holder)

    def flush(self):
        pass


def reset_logging():
    """Remove all current handlers and unset log level."""
    log = logging.getLogger()
    handlers = list(log.handlers)
    for h in handlers:
        h.flush()
        h.close()
        log.removeHandler(h)
    log.setLevel(logging.NOTSET)


def setup_backup_logging():
    """In the event that internal logging exception occurs and logging is not
    possible for some reason, make a desparate final attempt to log to stderr
    which may ease debugging.
    """
    fallback_handler = logging.StreamHandler(sys.stderr)
    fallback_handler.handleError = lambda record: None
    fallback_handler.setFormatter(
        logging.Formatter(
            "FALLBACK: %(asctime)s - %(filename)s[%(levelname)s]: %(message)s"
        )
    )

    def handleError(self, record):
        """A closure that emits logs on stderr when other methods fail"""
        with suppress(IOError):
            fallback_handler.handle(record)
            fallback_handler.flush()

    logging.Handler.handleError = handleError


def configure_root_logger():
    """Customize the root logger for cloud-init"""

    # Always format logging timestamps as UTC time
    logging.Formatter.converter = time.gmtime
    define_deprecation_logger()
    setup_backup_logging()
    reset_logging()

    # add handler only to the root logger
    handler = LogExporter()
    handler.setLevel(logging.WARN)
    logging.getLogger().addHandler(handler)

Directory Contents

Dirs: 11 × Files: 29

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
analyze DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
cmd DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
config DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
distros DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
filters DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
handlers DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
mergers DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
net DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
reporting DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
sources DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
apport.py	7.05 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
atomic_helper.py	2.45 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cloud.py	3.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
dmi.py	6.77 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
event.py	2.00 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
features.py	3.38 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
gpg.py	4.28 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
helpers.py	16.41 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
importer.py	2.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
log.py	5.47 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
netinfo.py	22.97 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
persistence.py	2.52 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
registry.py	1022 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
safeyaml.py	10.28 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
settings.py	2.02 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
signal_handler.py	1.74 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
simpletable.py	1.93 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
ssh_util.py	22.28 KB	lrw-r--r--	2026-01-23 08:56:47	Edit Download recursive recursive
stages.py	38.88 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
subp.py	13.23 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
templater.py	5.95 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
temp_utils.py	3.15 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
type_utils.py	703 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
url_helper.py	27.32 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
user_data.py	14.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
util.py	96.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
version.py	566 B	lrw-r--r--	2026-01-23 08:56:50	Edit Download recursive recursive
warnings.py	3.76 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
__init__.py	0 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive