给 Django 日志加上 request id,方便追踪请求

朱雀 2022-11-16 13:51 164阅读 0赞

注：本文大部分内容参考自：https://blog.csdn.net/handsomekang/article/details/78661392  
但是因为原文有些点没有说的太清楚，不是面向初学者的，特把相关点说清楚

request id 用来标识同一个请求的日志，方便检索和分析。

request\_id用一个小算法自动生成。如果请求头有 X-Request-ID，就用请求头的，这样一个请求涉及多个服务调用的时候可以把request\_id带过去，标识为同一个请求的request\_id.

下面是代码示例

> 本例整体目标是  
> 1、在请求一开始打印请求基础信息(如 request path、get params)  
> 2、打印日志时将 request id 带上，方便追踪请求

# 1. 定义 Middleware 和 Logging Filter #

>   
> 注：本示例文件路径为 dataStatistics.log\_middleware.py
> 
>   
> \# -\*- coding: utf-8 -\*-  
> from \_\_future\_\_ import unicode\_literals
> 
> import logging  
> import threading
> 
> from django.utils.deprecation import MiddlewareMixin
> 
> local = threading.local()  
> logger = logging.getLogger('tracer')
> 
> class RequestIDFilter(logging.Filter):  
>     def filter(self, record):  
>         record.request\_id = getattr(local, 'request\_id', "none")  
>         return True
> 
>   
> def get\_current\_time(format=None):  
>     from datetime import datetime  
>     dt = datetime.now()  
>     if format:  
>         result = dt.strftime(format)  
>     else:  
>         result = dt.strftime("%Y/%m/%d %H:%M:%S")  
>     return result
> 
>   
> def base\_n(num, b):  
>     return ((num == 0) and "0") or \\  
>            (base\_n(num // b, b).lstrip("0") + "0123456789abcdefghijklmnopqrstuvwxyz"\[num % b\])
> 
>   
> def generate\_sid():  
>     sid = get\_current\_time("%H%M%S%f")  
>     sid = int(sid)  
>     \# 将 10 进制转为 32 进制  
>     sid = base\_n(sid, 32)  
>     \# 反转  
>     return "\{\}".format(sid)\[::-1\]
> 
>   
> class RequestIDMiddleware(MiddlewareMixin):  
>     def process\_request(self, request):  
>         local.request\_id = request.META.get('HTTP\_X\_REQUEST\_ID', generate\_sid())  
>         logger.info("+++++ request\_begin: \[\{\}\] \[\{\}\] \{\}".format(request.path, request.method, list(request.GET.items())))
> 
>     def process\_response(self, request, response):  
>         logger.info("----- request\_end: \[\{\}\]".format(request.path))  
>         if hasattr(request, 'request\_id'):  
>             response\['X-Request-ID'\] = local.request\_id  
>         try:  
>             del local.request\_id  
>         except AttributeError:  
>             pass  
>         return response

# 2. 在 settings.py 中注册 自定义的 Middleware 并 使用 filter #

MIDDLEWARE配置示例：MIDDLEWARE = \[  
    'dataStatistics.log\_middleware.RequestIDMiddleware'  
\]  
  
LOGGING配置示例：

> LOGGING = \{  
>     'version': 1,  
>     'disable\_existing\_loggers': False,  
>     'formatters': \{  
>         'track': \{  
>             'format': '%(levelname)s \[%(asctime)s\] \[%(request\_id)s\] : %(message)s'  \# 这里使用filter request\_id里的request\_id字段  
>         \},  
>         'simple': \{  
>             'format': '\{levelname\} \{message\}',  
>             'style': '\{',  
>         \},  
>     \},  
>     'filters': \{  
>         'require\_debug\_true': \{  
>             '()': 'django.utils.log.RequireDebugTrue',  
>         \},  
>         'request\_id': \{  
>             \# 自定义的filter  
>             '()': 'dataStatistics.log\_middleware.RequestIDFilter'  
>         \}  
>     \},  
>     'handlers': \{  
>         'console': \{  
>             'level': 'DEBUG',  
>             'filters': \['require\_debug\_true'\],  
>             'class': 'logging.StreamHandler',  
>             'formatter': 'track'  
>         \},  
>         'tracer': \{  
>             'level': 'DEBUG',  
>             'class': 'logging.StreamHandler',  
>             'filters': \['request\_id'\],  
>             \# 对应 formatters 中 的 track  
>             'formatter': 'track'  
>         \}  
>     \},  
>     'loggers': \{  
>         'django': \{  
>             'handlers': \['console'\],  
>             'propagate': True,  
>         \},  
>         'tracer': \{  
>             \# 对应 handlers 中的 tracer  
>             'handlers': \['tracer'\],  
>             \# change debug level as appropiate  
>             'level': 'DEBUG',  
>             'propagate': True,  
>         \}  
>     \}  
> \}

#    3. 在代码中使用 #

首先拿到配置的 logger 对象：  
logger 其实都是 settings.py 中 loggers 所定义的

logger = logging.getLogger('tracer')  
  
然后使用时直接调用即可，如：  
logger.debug("my debug demo")  
logger.info("my info demo")  
  
  
效果如下：  
INFO \[2019-11-01 16:28:12,744\] \[pfja6kn4\] : +++++ request\_begin: \[/warehouse/demo/\] \[GET\] \[('parm1', 'value1'), ('parm2', 'value2')\]  
DEBUG \[2019-11-01 16:28:12,746\] \[pfja6kn4\] : my debug demo  
INFO \[2019-11-01 16:28:12,746\] \[pfja6kn4\] : my info demo  
INFO \[2019-11-01 16:28:12,750\] \[pfja6kn4\] : ----- request\_end: \[/warehouse/demo/\]  
————————————————  
版权声明：本文为CSDN博主「杨筱毅」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。  
原文链接：https://blog.csdn.net/lonewolf521125/article/details/102861158