Skip to content

Adapter logging

_get_default_log_level(default_level=logging.INFO)

Retrieves the default logging level from a config file, or returns a default value.

Parameters:

Name Type Description Default
default_level int

The default logging level if not set in the config file. Defaults to logging.INFO.

 INFO

Returns:

Name Type Description
int int

The default logging level.
Source code in lib/python/src/aria/ops/adapter_logging.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def _get_default_log_level(default_level: int = logging.INFO) -> int:
    """
    Retrieves the default logging level from a config file, or returns a default value.

    Args:
        default_level (int, optional): The default logging level if not set in the config file.
                                        Defaults to logging.INFO.

    Returns:
        int: The default logging level.
    """
    default_level_name = logging.getLevelName(default_level)
    log_config_file = os.path.join(os.sep, "var", "log", "loglevels.cfg")
    config = ConfigParser()
    if os.path.isfile(log_config_file):
        config.read(log_config_file)
    modified = False
    if "adapter" not in config["DEFAULT"]:
        modified = True
        config["DEFAULT"].update({"adapter": default_level_name})
    if "adapter" not in config:
        modified = True
        config["adapter"] = {
            "__main__": default_level_name,
        }
    if modified:
        try:
            with open(log_config_file, "w") as config_file:
                config.write(config_file)
        except Exception as e:
            logging.exception(e)
    try:
        return int(
            logging.getLevelName(config["DEFAULT"].get("adapter", default_level_name))
        )
    except ValueError:
        return default_level

_set_log_levels()

Sets the logging levels for each logger as defined in a config file.

Source code in lib/python/src/aria/ops/adapter_logging.py 
89
90
91
92
93
94
95
96
97
98
def _set_log_levels() -> None:
    """
    Sets the logging levels for each logger as defined in a config file.
    """
    log_config_file = os.path.join(os.sep, "var", "log", "loglevels.cfg")
    config = ConfigParser()
    if os.path.isfile(log_config_file):
        config.read(log_config_file)
        for logger in config["adapter"]:
            logging.getLogger(logger).setLevel(config["adapter"][logger])

getLogger(name)

A convenience function to get a logger with a specific name.

Parameters:

Name Type Description Default
name str

The name of the logger.

 required

Returns:

Type Description
Logger

logging.Logger: The requested logger.
Source code in lib/python/src/aria/ops/adapter_logging.py 
101
102
103
104
105
106
107
108
109
110
111
def getLogger(name: str) -> logging.Logger:
    """
    A convenience function to get a logger with a specific name.

    Args:
        name (str): The name of the logger.

    Returns:
        logging.Logger: The requested logger.
    """
    return logging.getLogger(name)

rotate()

Rotates the current adapter logs to their backups (e.g., adapter.log to adapter.log.1) and starts logging to the new adapter.log file.

Source code in lib/python/src/aria/ops/adapter_logging.py 
114
115
116
117
118
119
120
def rotate() -> None:
    """
    Rotates the current adapter logs to their backups (e.g., `adapter.log` to
    `adapter.log.1`) and starts logging to the new adapter.log file.
    """
    if log_handler:
        log_handler.doRollover()

setup_logging(filename, file_count=5, max_size=0)

Sets up logging using the given parameters.

Parameters:

Name Type Description Default
filename str

The name of the file to log to.

 required
file_count int

The total number of files to retain. Defaults to 5.

 5
max_size int

The maximum size in bytes of each file before the file automatically rotates to a new one. Defaults to '0', which will do no automatic rotation. Requires calling the 'rotate()' function manually to ensure logs do not become too large.

 0
Source code in lib/python/src/aria/ops/adapter_logging.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def setup_logging(filename: str, file_count: int = 5, max_size: int = 0) -> None:
    """
    Sets up logging using the given parameters.

    Args:
        filename (str): The name of the file to log to.
        file_count (int, optional): The total number of files to retain. Defaults to 5.
        max_size (int, optional): The maximum size in bytes of each file before the file
                                  automatically rotates to a new one. Defaults to '0', which will
                                  do no automatic rotation. Requires calling the 'rotate()' function
                                  manually to ensure logs do not become too large.
    """
    logdir = os.path.join(os.sep, "var", "log")
    if os.access(logdir, os.W_OK):
        try:
            global log_handler
            log_handler = RotatingFileHandler(
                os.path.join(os.sep, "var", "log", filename),
                maxBytes=max_size,
                backupCount=file_count,
            )
            logging.basicConfig(
                format="%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s",
                datefmt="%Y-%m-%d %H:%M:%S",
                level=_get_default_log_level(),
                handlers=[log_handler],
            )
            _set_log_levels()
        except Exception as e:
            logging.basicConfig(level=logging.INFO)
            logging.exception(e)
    else:
        logging.basicConfig(level=logging.INFO)
        logging.exception(
            f"Cannot write to log file '{os.path.join(logdir, filename)}'"
        )