Skip to content

academy.logging.configs.jsonpool

JSONPoolLogging 

JSONPoolLogging()

Bases: LogConfig

Configures logging to files in home directory based pool of logs.

This feature is aimed at mechanical processing of logs, rather than human readability.

Logs written by this configuration are stored in JSON format under ~/local/share/academy/logs/

Under that directory, logs are first separated into directories by the (distributed) identity of the log configuration: logs configured by the same JSONPoolLogging object, or by a serialized/deserialized copy of the same object, will appear under the same directory.

Within that directory, each instance of log initialization will get a new log file.

This logger is not configurable: it is intended to capture full debug logs from the root, with selection of log records made during the mechanical analysis stage.

Source code in academy/logging/configs/jsonpool.py 
36
37
38
39
def __init__(
    self,
) -> None:
    super().__init__()

init_logging 

init_logging() -> Callable[[], None]

Initialize JSON logging into shared pool.

Source code in academy/logging/configs/jsonpool.py 
41
42
43
44
45
46
47
48
49
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
def init_logging(self) -> Callable[[], None]:
    """Initialize JSON logging into shared pool."""
    instance_id = str(uuid.uuid4())

    # Home resolution is deferred until init_logging time because the path
    # can be different on every invocation as the config object is moved
    # between execution hosts.
    path = (
        pathlib.Path.home()
        / 'local'
        / 'share'
        / 'academy'
        / 'logs'
        / self.uuid
        / instance_id
    )
    path.parent.mkdir(parents=True, exist_ok=True)

    json_handler = JSONHandler(path.with_suffix('.jsonlog'))
    json_handler.setLevel(logging.DEBUG)

    root_logger = logging.getLogger()
    root_logger.addHandler(json_handler)
    root_logger.level = min(root_logger.level, json_handler.level)

    logger.info(
        'Configured JSONPoolLogging (pool uuid=%s, path=%s)',
        self.uuid,
        path,
    )

    def uninitialize_callback() -> None:
        root_logger.removeHandler(json_handler)
        json_handler.close()

    return uninitialize_callback