[PYTHON] Afficher les informations utilisateur, etc. dans le journal Django

Lorsque vous essayez de générer des informations qui ne figurent pas dans l 'attribut LogRecord telles que demander des informations utilisateur dans le journal Django,

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

Vous pouvez trouver quelque chose comme ça, mais c'est un peu différent. Il y avait une solution quand je pensais qu'il y avait des développeurs qui ne suivaient pas les règles et que cela ne fonctionnait que pour les logs que j'avais écrits.

Aperçu

-Utilisez Middleware pour définir les informations utilisateur sur threading.local () lors de la demande --Ajoutez les informations utilisateur de threading.local () à LogRecord avec logging.filter --LOGGING paramètres dans settings.py

Middleware

• Obtenez le nom d'utilisateur de la demande. (S'il s'agit d'une API, vous pouvez pharse JWT pour obtenir des informations utilisateur ...)
• Définissez le nom d'utilisateur obtenu ci-dessus sur threading.local (). (Pour référence à partir du filtre ci-dessous) --Définissez None pour effacer après self.get_response (request)

python

import logging
import threading

local = threading.local()

class CustomAttrMiddleware:
    """
Middleware pour obtenir des éléments personnalisés à afficher dans le journal
    """
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        """
Obtenez le nom d'utilisateur de la demande lors de la demande du client
        threading.local()Enregistrer temporairement dans
        """
        if request.user:
            setattr(local, 'user', request.user.username)
        else:
            setattr(local, 'user', None)

        response = self.get_response(request)

        #Effacer en répondant
        setattr(local, 'user', None)

        return response

filter

• Définissez le nom d'utilisateur défini dans threading.local () dans Middleware sur LogRecord.
• Assurez-vous de renvoyer True.

python

class CustomAttrFilter(logging.Filter):
    """
filtre pour la sortie des éléments personnalisés dans le journal
    """
    def filter(self, record):
        record.user = getattr(local, 'user', None)
        return True

settings.py

• Ajoutez le middleware créé ci-dessus. --Ajout du format de sortie utilisateur (user =% (user) s) aux formateurs LOGGING --Ajoutez le filtre créé ci-dessus aux filtres de LOGGING --Définissez le filtre ajouté à utiliser par les gestionnaires de LOGGING

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']
        },
    },
     ...
}

vues (pour vérification de fonctionnement)

python

class LoggingExceptListView(generics.ListAPIView):
    """
ListView pour voir la sortie d'exception dans le journal
    """
    def list(self, request, *args, **kwargs):
        """
Soulevez simplement une exception
        """
        raise Exception('Pour vérifier les journaux')

résultat de la sortie du journal

--Exécuter les vues de contrôle des opérations ci-dessus --La partie "user = CustomAttrUser" du journal ci-dessous

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('Pour vérifier les journaux')

La source

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

Les références

• Django: Adding a Custom Attribute to All Log Lines