簡介

在開發大型系統的時候，往往是進行微服務化，變成了多個系統之間的交互。快速迭代你會發現線上的系統很多很復雜，這時候一個用戶請求過來會經過很多內部系統，如果這時候發生錯誤，我們去查看日志的時候，根本不知道，哪個錯誤來自哪一個用戶，這時候我們給每一個請求加上一個Request ID就可以很好的區分了。

django-log-request-id

這個項目為我們提供了輪子，直接使用即可

github: https://github.com/dabapps/django-log-request-id （本地下載）

安裝

pip install django-log-request-id

添加middleware

需要加在其它middleware前面

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

header中添加RequestID

LOG_REQUEST_ID_HEADER = "HTTP_X_REQUEST_ID"GENERATE_REQUEST_ID_IF_NOT_IN_HEADER = TrueREQUEST_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帶過去，標識為同一個請求的request_id.

下面是代碼示例。

在一個文件中自定義Middleware和Logging Filter.

import loggingimport threadingimport uuidfrom django.utils.deprecation import MiddlewareMixinlocal = threading.local()class RequestIDFilter(logging.Filter): def filter(self, record): record.request_id = getattr(local, 'request_id', "none") return Trueclass 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, }, }}