快捷導(dǎo)航

django日志默認(rèn)打印request請(qǐng)求信息的方法示例

更新時(shí)間：2020年05月17日 16:10:44 作者：歪文

這篇文章主要給大家介紹了關(guān)于django日志默認(rèn)打印request請(qǐng)求信息的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或者使用django具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

需求

請(qǐng)求view中手動(dòng)打印日志時(shí)中插入request的如下信息（每個(gè)request請(qǐng)求都記錄可以使用中間件進(jìn)行解決，但這里僅僅是在需要的地方手動(dòng)打印）：

 #統(tǒng)一附加日志內(nèi)容

ADD_LOG = r'''{"username": request.user, "path": request.path, "request_id": request.id, "login_id": request.login_id}'''

舊的解決辦法

在每次需要打印日志時(shí)，通過(guò) logging extra 進(jìn)行額外的打印信息添加：每次手動(dòng)添加同樣的extra非常的不優(yōu)雅。

新的解決方案

django 自帶log系統(tǒng)官方文檔

1、熟悉python的logging模塊結(jié)構(gòu)。

Loggers
Handlers
Filters
Formatters

2、django中間件存儲(chǔ)request信息。

class RequestLogMiddleware(MiddlewareMixin):
  """
  將request的信息記錄在當(dāng)前的請(qǐng)求線(xiàn)程上
  """
  def process_request(self, request):
    # 統(tǒng)一附加日志內(nèi)容
    # ADD_LOG = r'''{"username": request.user, "path": request.path, "request_id": request.id, "login_id": request.login_id}'''
    local.path = request.path
    local.request_id = request.id
    local.login_id = request.login_id
    local.username = request.user.username

3、logging的filters模塊添加request信息。

import logging

class RequestLogFilter(logging.Filter):
  """
  日志過(guò)濾器，將當(dāng)前請(qǐng)求線(xiàn)程的request信息保存到日志的record上下文
  """
  def filter(self, record):
    record.request_id = getattr(local, 'request_id', "none")
    record.path = getattr(local, 'path', "none")
    record.login_id = getattr(local, 'login_id', "none")
    record.username = getattr(local, 'username', "none")
    record.appName = getattr(local, "appName", "none")
    return True

4、實(shí)現(xiàn)原理及代碼

通過(guò) local = threading.local()。

middleware-waiwen文件代碼：

import threading
import logging
try:
  from django.utils.deprecation import MiddlewareMixin # Django 1.10.x
except ImportError:
  MiddlewareMixin = object # Django 1.4.x - Django 1.9.x

local = threading.local()
class RequestLogFilter(logging.Filter):
  """
  日志過(guò)濾器，將當(dāng)前請(qǐng)求線(xiàn)程的request信息保存到日志的record上下文
  record帶有formater需要的信息。
  """
  def filter(self, record):
    record.request_id = getattr(local, 'request_id', "none")
    record.path = getattr(local, 'path', "none")
    record.login_id = getattr(local, 'login_id', "none")
    record.username = getattr(local, 'username', "none")
    return True

class RequestLogMiddleware(MiddlewareMixin):
  """
  將request的信息記錄在當(dāng)前的請(qǐng)求線(xiàn)程上。
  """
  def process_request(self, request):
    # 統(tǒng)一附加日志內(nèi)容
    # ADD_LOG = r'''{"username": request.user, "path": request.path, "request_id": request.id, "login_id": request.login_id}'''
    local.path = request.path
    local.request_id = request.id
    local.login_id = request.login_id
    local.username = request.user.username

settings 文件配置

MIDDLEWARE = [
  'django.middleware.security.SecurityMiddleware',
  'django.contrib.sessions.middleware.SessionMiddleware',
  'django.middleware.common.CommonMiddleware',
  'django.middleware.csrf.CsrfViewMiddleware',
  'django.contrib.auth.middleware.AuthenticationMiddleware',
  'django.contrib.messages.middleware.MessageMiddleware',
  'django.middleware.clickjacking.XFrameOptionsMiddleware',
 
  'wcloud.middleware-waiwen.RequestLogMiddleware' 
   #使用該中間件
   #將當(dāng)前的request信息保存到當(dāng)前線(xiàn)程供日志打印使用
]


LOGGING = {
    # 日志相關(guān)
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
      'standard': {
        'format': '{"date": "%(created)f", "level": "%(levelname)s", "funcName": "%(module)s.%(funcName)s:%(lineno)d", "msg": "%(message)s"}'}, # 日志格式
      'custom': {
       #該格式化中包含有過(guò)濾器record新增的字段
        'format': '{"date": "%(created)f", "level": "%(levelname)s", "funcName": "%(module)s.%(funcName)s:%(lineno)d", "request_id": "%(request_id)s","login_id": "%(login_id)s", "username": "%(username)s", "path": "%(path)s","msg": "%(message)s"}'
      },
    },
    'filters': {
      #注冊(cè)該過(guò)濾器
      'request_info': {'()': 'wcloud.middleware-waiwen.RequestLogFilter'}
    },
    'handlers': {
      'log': {
        'level': 'DEBUG',
        'class': 'logging.StreamHandler',
        'formatter': 'custom',
       #在該過(guò)handler中使用該過(guò)濾器
        'filters': ['request_info'], 
      },
      'console': {
        'level': 'DEBUG',
        'class': 'logging.StreamHandler',
        'formatter': 'standard',
      },
    },
    'loggers': {
      'django': {
        'handlers': ['console'],
        'level': 'ERROR',
        'propagate': False
      },
      'django.request': {
        'handlers': ['console'],
        'level': 'ERROR',
        'propagate': False
      },
      'django.db.backens': {
        'handlers': ['console'],
        'level': 'DEBUG',
        'propagate': False
      },
      'log': {
        'handlers': ['log'],
        'level': 'INFO',
        'propagate': True
      },
      
    }
  }

5、效果

參考：

給Django日志加上request_id

總結(jié)

到此這篇關(guān)于django日志默認(rèn)打印request請(qǐng)求信息的文章就介紹到這了,更多相關(guān)django日志默認(rèn)打印request請(qǐng)求信息內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: