[PYTHON] Benutzerinformationen usw. in das Django-Protokoll ausgeben

Wenn Sie versuchen, Informationen auszugeben, die nicht im [LogRecord-Attribut] enthalten sind (https://docs.python.org/ja/3/library/logging.html#logrecord-attributes), z. B. Benutzerinformationen an das Django-Protokoll anfordern,

logger.info(message, extra={'username' : request.user.username})

Sie können so etwas finden, aber es ist ein bisschen anders. Es gab eine Lösung, als ich dachte, dass es Entwicklungsmitglieder gibt, die sich nicht an die Regeln halten, und dass dies nur für die von mir geschriebenen Protokolle funktioniert.

Überblick

• Verwenden Sie Middleware, um Benutzerinformationen auf Anfrage auf threading.local () zu setzen
• Fügen Sie mit [logging.filter] Benutzerinformationen von threading.local () zu LogRecord hinzu (https://docs.python.org/ja/3/library/logging.html#logging.Logger.filter). --LOGGING-Einstellungen in settings.py

Middleware

• Holen Sie sich den Benutzernamen von der Anfrage. (Wenn es sich um eine API handelt, können Sie JWT fälschen, um Benutzerinformationen abzurufen ...)
• Setzen Sie den oben erhaltenen Benutzernamen auf threading.local (). (Als Referenz vom Filter unten) --Set Keine zum Löschen nach self.get_response (Anfrage)

python

import logging
import threading

local = threading.local()

class CustomAttrMiddleware:
    """
Middleware, um benutzerdefinierte Elemente zur Protokollierung auszugeben
    """
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        """
Rufen Sie den Benutzernamen der Anfrage ab, wenn Sie vom Client eine Anfrage stellen
        threading.local()Vorübergehend speichern bis
        """
        if request.user:
            setattr(local, 'user', request.user.username)
        else:
            setattr(local, 'user', None)

        response = self.get_response(request)

        #Klar, wenn Sie antworten
        setattr(local, 'user', None)

        return response

filter

• Setzen Sie den in threading.local () in Middleware festgelegten Benutzernamen auf LogRecord.
• Stellen Sie sicher, dass True zurückgegeben wird.

python

class CustomAttrFilter(logging.Filter):
    """
Filter für die Ausgabe von benutzerdefinierten Elementen zum Protokollieren
    """
    def filter(self, record):
        record.user = getattr(local, 'user', None)
        return True

settings.py

• Fügen Sie die oben erstellte Middleware hinzu.
• Benutzerausgabeformat (Benutzer =% (Benutzer) s) zu LOGGING-Formatierern hinzugefügt
• Fügen Sie den oben erstellten Filter zu den Filtern von LOGGING hinzu --Stellen Sie den hinzugefügten Filter ein, der von den Handlern von LOGGING verwendet werden soll

python

MIDDLEWARE = [
     ...
    'middleware.custom_logging.CustomAttrMiddleware',
]

LOGGING = {
     ...
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s '
                      '%(process)d %(thread)d user=%(user)s %(message)s'
        },
    },
    'filters' : {
        'custom': {
            '()': 'middleware.custom_logging.CustomAttrFilter'
        },
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'verbose',
            'filters': ['custom']
        },
    },
     ...
}

Ansichten (zur Funktionsprüfung)

python

class LoggingExceptListView(generics.ListAPIView):
    """
ListView, um die Ausnahmeausgabe im Protokoll anzuzeigen
    """
    def list(self, request, *args, **kwargs):
        """
Erhöhen Sie einfach eine Ausnahme
        """
        raise Exception('Zum Überprüfen von Protokollen')

Ergebnis der Protokollausgabe

• Führen Sie die obigen Operationsprüfansichten aus
• Der Teil "user = CustomAttrUser" des folgenden Protokolls

python

ERROR 2020-05-06 17:12:02,703 log 13516 10376 user=CustomAttrUser Internal Server Error: /sample_api/logging-exp/
Traceback (most recent call last):
  File "C:\ProgramData　...
　...  raise Exception('Zum Überprüfen von Protokollen')

Quelle

https://github.com/ping2shi2/DRF-sample

Verweise

• Django: Adding a Custom Attribute to All Log Lines