python - 使用 Django + Gunicorn 应用程序在标准输出上打印用户名

Question

现在我的 Django + Gunicorn 应用程序仅打印此信息:

[03.10.2022 19:43:14] INFO [django.request:middleware] GET /analyse/v2/ping - 200

如果请求被授权，我还想在状态代码后面显示用户(用户名/电子邮件)，例如:

[03.10.2022 19:43:14] INFO [django.request:middleware] GET /analyse/v2/ping - 200 - useremail@outlook.com

如果请求未被授权则写入 UNAUTHORIZED:

[03.10.2022 19:43:14] INFO [django.request:middleware] GET /analyse/v2/ping - 200 - UNAUTHORIZED

我如何结合使用 Django 和 Gunicorn 来实现这一点？

谢谢

通过在设置中添加这部分代码解决:

def add_username(record):
    try:
        username = record.request.user.username
    except AttributeError:
        username = ""
    record.username = username
    return True

LOGGING = {
    "version": 1,
    "disable_existing_loggers": True,
    "root": {"level": "WARNING", "handlers": ["console"]},
    "formatters": {
        "verbose": {
            "format": "[%(asctime)s] %(levelname)s [%(name)s:%(module)s] [%(username)s] %(message)s",
            "datefmt": "%d.%m.%Y %H:%M:%S",
        },
        "simple": {"format": "%(levelname)s %(message)s"},
    },
    "filters": {
        "add_username": {
            "()": "django.utils.log.CallbackFilter",
            "callback": add_username,
        }
    },
    "handlers": {
        "console": {
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "verbose",
            "filters": ["add_username"],
        },
    ...

Answer 1

尚不清楚此日志行的来源。据我所知，Django 仅将 4xx 和 5xx 请求记录到 django.request 记录器。这看起来也不像 gunicorn 访问日志行。如果您在自己的代码中启动此日志行，您应该能够轻松添加用户。

因此，这里有一些通用的解决方案。

---

(选项 1)对于 gunicorn 访问日志行

您无权访问 Django 的请求对象，因此无法从 gunicorn 检索用户。但是，您可以通过在响应 header 中添加用户来解决这个问题。

yourapp/middleware.py

class UserHeaderMiddleware:

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        response = self.get_response(request)
        user = request.user
        response['X-User'] = user.email if user.is_authenticated() else 'UNAUTHORIZED'
        return response

yourproject/settings.py

MIDDLEWARE = [
    ...,
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    ...,  # Your custom middleware must be called after authentication
    'yourapp.middleware.UserHeaderMiddleware',
    ...,
]

然后更改 gunicorn 的 access_log_format 设置以包含此 header 。例如:'%(h)s %(l)s %(u)s %(t)s "%(r)s"%(s)s %(b)s "%(f)s ""%({x-user}o)s"'

---

(选项 2)对于 django.request 记录器

如果您的日志行被发送到 django.request 记录器，它有可能提供了 the request in the extra context .

在这种情况下，您可以编写一个自定义格式化程序来包含用户:

yourapp/logging.py

from logging import Formatter

class RequestFormatter(Formatter):

    def format(self, record):
        request = getattr(record, 'request', None)
        if user := getattr(request, 'user', None):
            record.user = user.email if user.is_authenticated() else 'UNAUTHORIZED'
        else:
            record.user = '-'
        return super().format(record)

yourapp/logging.py

LOGGING = {
    ...,
    'formatters': {
        ...,
        "django.request": {
            "()": "yourapp.logging.RequestFormatter",
            "format": "[{asctime}] {levelname} [{name}] {message} - {status_code} - {user}",
            "style": "{",
        },
    },
    'loggers': {
        ...,
        "django.request": {
            "handlers": ...,
            "level": "INFO",
            "formatter": 'django.request',
       }
       ...,
    },
}

---

(选项 3)告诉 Django 在 django.request

中记录所有请求

Django 仅在 django.request 中记录 4xx 和 5xx 请求。 See source code

但我们可以通过使用自定义 WSGI 处理程序来改变这种行为。

在 yourproject/wsgi.py 中你应该有这样的东西:

import os
from django.core.wsgi import get_wsgi_application
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'yourproject.settings')
application = get_wsgi_application()

您可以更改它以使用自定义 WSGI 处理程序:

import os
import django
from django.core.wsgi import WSGIHandler
from django.conf import settings
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'yourproject.settings')


class CustomWSGIHandler(WSGIHandler):
    def get_response(self, request):
        # Note that this is only a copy of BaseHandler.get_response()
        # without the condition on log_response()
        set_urlconf(settings.ROOT_URLCONF)
        response = self._middleware_chain(request)
        response._resource_closers.append(request.close)
        log_response(
            "%s: %s",
            response.reason_phrase,
            request.path,
            response=response,
            request=request,
        )
        return response

django.setup(set_prefix=False)
application = CustomWSGIHandler()

然后，引用选项 2 将用户包含在格式化程序中。

---

(选项 4)创建中间件以添加新的日志行

如果无法访问此日志行来更新它并且无法访问日志格式化程序中的请求，您将不得不手动添加一个新的日志行(并且可能会静默第一个以避免重复).

yourapp/middleware.py

import logging

logger = logging.getLogger('django.request')

class LoggingMiddleware:

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        response = self.get_response(request)
        user_email = request.user.email if request.user.is_authenticated() else 'UNAUTHORIZED'
        logger.info(f"{request.method} {request.path} - {request.status_code} - {user_email}")
        return response

yourproject/settings.py

MIDDLEWARE = [
    ...,
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    ...,  # Your custom middleware must be called after authentication
    'yourapp.middleware.LoggingMiddleware',
    ...,
]