loggingmanager.py

"""A middleware to export user IDs for logging.

Werkzeug logs the request after the Flask app context has ended
so we use Werkzeug's Local object to pass the user ID into the
logging formatter.
"""

import logging
import os

from werkzeug.local import Local, LocalManager

local = Local()
local_manager = LocalManager([local])


class ContextFormatter(logging.Formatter):
    """A logging formatter which inserts the user ID
    into the logging record."""

    def format(self, record):
        record.user = getattr(local, "user_id", None)
        record.pid = os.getpid()
        return logging.Formatter.format(self, record)


class NoStaticFilter(logging.Filter):
    """Disable logging of static content requests."""

    def filter(self, record: logging.LogRecord) -> bool:
        return "/static/" not in record.getMessage()


def set_user_id(uid):
    """Set the user ID for later use in logging."""
    local.user_id = uid


def create_logging_manager(app):
    app.wsgi_app = local_manager.make_middleware(app.wsgi_app)