Skip to content

bootstrap

log_panel.bootstrap

bootstrap_log_panel()

Configure log panel integration after Django app loading.

Source code in log_panel/bootstrap.py 
19
20
21
22
def bootstrap_log_panel() -> None:
    """Configure log panel integration after Django app loading."""
    validate_database_router()
    configure_root_handler()

validate_database_router()

Ensure the configured log database alias is routed through LogsRouter.

Source code in log_panel/bootstrap.py 
25
26
27
28
29
30
31
32
33
def validate_database_router() -> None:
    """Ensure the configured log database alias is routed through LogsRouter."""
    if get_database_alias() and LOGS_ROUTER_PATH not in getattr(
        settings, "DATABASE_ROUTERS", []
    ):
        raise ImproperlyConfigured(
            "log_panel: DATABASE_ALIAS is configured but 'log_panel.routers.LogsRouter' "
            "is not in DATABASE_ROUTERS. Add it to route Log reads/writes to the correct database."
        )

build_database_handler()

Return the configured database logging handler.

Source code in log_panel/bootstrap.py 
36
37
38
39
40
41
42
43
def build_database_handler() -> DatabaseHandler:
    """Return the configured database logging handler."""
    buffer_size = get_setting(key="BUFFER_SIZE")
    handler: DatabaseHandler = (
        BufferedDatabaseHandler() if buffer_size is not None else DatabaseHandler()
    )
    handler.setLevel(level=get_setting(key="LOG_LEVEL"))
    return handler

attach_root_handler()

Attach the configured database handler to the root logger when enabled.

Source code in log_panel/bootstrap.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def attach_root_handler() -> None:
    """Attach the configured database handler to the root logger when enabled."""
    if not get_setting(key="ATTACH_ROOT_HANDLER"):
        return

    if not get_database_alias():
        return

    root: logging.Logger = logging.getLogger()

    for handler in root.handlers:
        if isinstance(handler, DatabaseHandler):
            warnings.warn(
                message="log_panel: ATTACH_ROOT_HANDLER is True but a "
                "DatabaseHandler is already "
                "attached to the root logger via Django LOGGING. Skipping auto-attach.",
                stacklevel=2,
            )
            return

    root.addHandler(hdlr=build_database_handler())
    root.setLevel(level=get_setting(key="LOG_LEVEL"))

configure_root_handler()

Attach immediately for commands, or defer server attachment until request handling.

Source code in log_panel/bootstrap.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def configure_root_handler() -> None:
    """Attach immediately for commands, or defer server attachment until request handling."""
    if not get_setting(key="ATTACH_ROOT_HANDLER"):
        return

    if not get_database_alias():
        return

    if is_migration_command():
        return

    if should_defer_root_handler_attachment():
        request_started.connect(
            attach_root_handler_on_request_started,
            dispatch_uid=REQUEST_STARTED_DISPATCH_UID,
            weak=False,
        )
        return

    attach_root_handler()

attach_root_handler_on_request_started(**kwargs)

Attach the root handler once the serving process handles its first request.

Source code in log_panel/bootstrap.py 
92
93
94
95
def attach_root_handler_on_request_started(**kwargs) -> None:
    """Attach the root handler once the serving process handles its first request."""
    request_started.disconnect(dispatch_uid=REQUEST_STARTED_DISPATCH_UID)
    attach_root_handler()

should_defer_root_handler_attachment()

Return whether root logging should wait until the serving process handles requests.

Source code in log_panel/bootstrap.py 
 98
 99
100
101
102
103
104
105
106
def should_defer_root_handler_attachment() -> bool:
    """Return whether root logging should wait until the serving process handles requests."""
    command_names = {Path(argument).name for argument in sys.argv}
    if command_names & SERVER_COMMANDS:
        return True
    # Handle `python -m <server>` where sys.argv[0] is .../server/__main__.py
    if sys.argv and set(Path(sys.argv[0]).parts) & SERVER_COMMANDS:
        return True
    return False

is_migration_command()

Return whether the current process is running Django migration orchestration.

Source code in log_panel/bootstrap.py 
109
110
111
112
def is_migration_command() -> bool:
    """Return whether the current process is running Django migration orchestration."""
    command_names = {Path(argument).name for argument in sys.argv}
    return bool(command_names & MIGRATION_COMMANDS)