Django中利用Request ID实现日志追踪与微服务调用链分析

Finn

发布时间：2026-10-13 | 3人浏览过

原创

本文介绍如何在Django项目中通过django-log-request-id库或自定义中间件为每个请求生成唯一Request ID，并将其注入日志格式中。该方法支持从HTTP头继承ID，便于在微服务架构下追踪跨系统请求链路，提升线上故障排查效率。

简介

在构建大型系统时，通常采用微服务架构，导致系统间交互复杂。随着快速迭代，线上系统数量庞大且结构错综复杂。当用户请求进入系统并经过多个内部服务时，若发生错误，传统日志难以区分具体是哪个用户的请求引发的。为此，为每个请求分配唯一的Request ID，能够有效区分不同请求的日志，便于问题定位。

django-log-request-id

该项目提供了现成的解决方案，开发者可直接集成使用。

项目地址：https://github.com/dabapps/django-log-request-id（支持本地下载）

安装

pip install django-log-request-id

配置中间件

需将该中间件配置在其他中间件之前，以确保其优先处理请求。

MIDDLEWARE_CLASSES = (
 'log_request_id.middleware.RequestIDMiddleware',
 # ... other middleware goes here
)

在HTTP Header中添加RequestID

LOG_REQUEST_ID_HEADER = "HTTP_X_REQUEST_ID"
GENERATE_REQUEST_ID_IF_NOT_IN_HEADER = True
REQUEST_ID_RESPONSE_HEADER = "RESPONSE_HEADER_NAME"

在日志记录中嵌入RequestID

LOGGING = {
 'version': 1,
 'disable_existing_loggers': False,
 'filters': {
 'request_id': {
  '()': 'log_request_id.filters.RequestIDFilter'
 }
 },
 'formatters': {
 'standard': {
  'format': '%(levelname)-8s [%(asctime)s] [%(request_id)s] %(name)s: %(message)s'
 },
 },
 'handlers': {
 'console': {
  'level': 'DEBUG',
  'class': 'logging.StreamHandler',
  'filters': ['request_id'],
  'formatter': 'standard',
 },
 },
 'loggers': {
 'myapp': {
  'handlers': ['console'],
  'level': 'DEBUG',
  'propagate': False,
 },
 }
}

为Django日志添加request_id字段

此举旨在标识属于同一请求的所有日志条目，从而方便后续的检索与数据分析。

request_id默认由系统自动生成UUID。若请求头中包含X-Request-ID，则优先使用该值。这种机制允许在涉及多个服务调用的场景中，将相同的request_id传递下去，从而标识整个调用链属于同一个请求。

以下是相关代码示例。

可在单独文件中定义自定义的Middleware和Logging Filter。

import logging
import threading
import uuid

from django.utils.deprecation import MiddlewareMixin

local = threading.local()


class RequestIDFilter(logging.Filter):
 def filter(self, record):
 record.request_id = getattr(local, 'request_id', "none")
 return True


class RequestIDMiddleware(MiddlewareMixin):
 def process_request(self, request):
 local.request_id = request.META.get('HTTP_X_REQUEST_ID', uuid.uuid4().hex)

 def process_response(self, request, response):
 if hasattr(request, 'request_id'):
  response['X-Request-ID'] = local.request_id
 try:
  del local.request_id
 except AttributeError:
  pass
 return response

随后在settings.py中进行引用配置。

LOGGING配置示例

LOGGING = {
 'filters': {
 'request_id': { # 自定义的filter
  '()': 'xxx.middlewares.RequestIDFilter'
 }
 },
 'formatters': {
 'standard': {
  'format': '%(levelname)s [%(asctime)s] [%(request_id)s] %(name)s: %(message)s' # 这里使用filter request_id里的request_id字段
 },
 },
 'handlers': {
 'console': {
  'level': 'DEBUG',
  'class': 'logging.StreamHandler',
  'filters': ['request_id'], # 这里使用上面的filter: request_id
  'formatter': 'standard', # 这里使用上面的formatter: standard
 },
 },
 'loggers': {
 'xxx': {
  'handlers': ['console'], # 这里使用上面的handler: console
  'level': 'DEBUG',
  'propagate': False,
 },
 }
}

完成上述配置后，代码中通过logging模块输出的日志将自动携带request_id信息。

总结

本文介绍了上述全部内容，希望能为读者的学习或工作提供参考价值。如有任何疑问，欢迎留言交流，感谢对本站的支持。