「Django 功能开发」Django 使用logging + Middleware 记录API日志功能开发

心已赠人 2022-09-04 04:48 214阅读 0赞

### 文章目录 ###

*  内容介绍
 *  ApiLoggingMiddleware 自定义中间件文件
 *  Settings.py 增加配置

# 内容介绍 #

基于 **Django REST framework** 构建 **Result API**，需要记录用户请求的时间、方法、数据、响应状态等信息。

通过 用 Python 的 **logging** 模块结合 Django框架 的 **Middleware**，来将每次API请求的详细信息记录下来。

Debug过程中显示结果大致如下。

INFO 2021-08-11 15:28:50,652 middleware process_response username POST /api/product/ { u'csrfmiddlewaretoken': [u'jAlRDXXXXXXXXzK8UnluvSzaz2yacdDzTwRE005aCVvYnINSG7xvraqi0Pu5QHur'], u'code': [u'test'], u'name': [u'\u53d1\u5e03\u7cfb\u7edf']} 201 Created
    INFO 2021-08-11 15:29:10,598 middleware process_response username GET /api/product/9/ { } 200 OK
    INFO 2021-08-11 15:29:15,252 middleware process_response username PUT /api/product/9/ { u'code': [u'test'], u'name': [u'\u53d1\u5e03']} 200 OK
    INFO 2021-08-11 15:29:27,603 middleware process_response username DELETE /api/product/9/ { } 200 OK
    INFO 2021-08-11 15:29:37,961 middleware process_response username GET /api/product/ { } 200 OK

结果会保存到对应目录的文件夹下。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]

# ApiLoggingMiddleware 自定义中间件文件 #

在应用下新建ApiLoggingMiddleware.py文件，确保路径正确。

import logging
    import json
    
    
    class ApiLoggingMiddleware(object):
        def __init__(self, get_response):
            self.get_response = get_response
            self.apiLogger = logging.getLogger('api')
    
        def __call__(self, request):
            try:
                body = json.loads(request.body)
            except Exception:
                body = dict()
            body.update(dict(request.POST))
            response = self.get_response(request)
            if request.method != 'GET':
                self.apiLogger.info("{} {} {} {} {} {}".format(
                    request.user, request.method, request.path, body,
                    response.status_code, response.reason_phrase))
            return response

# Settings.py 增加配置 #

# 增加中间件文件路径
    MIDDLEWARE_CLASSES = [
    	......
        'apps.appname.middleware.ApiLoggingMiddleware',
    ]
    
    # LOGGING 设置信息
    LOG_DIR = BASE_DIR + "/manage_log"
    LOGGING = { 
        'version': 1,
        'disable_existing_loggers': True,
        'formatters': { 
            'standard': { 
                'format': '%(asctime)s FuncName:%(funcName)s LINE:%(lineno)d [%(levelname)s]- %(message)s'
            },
            'simple': { 
                'format': '%(levelname)s %(message)s'
            },
            'verbose': { 
                'format': '%(levelname)s %(asctime)s %(module)s %(funcName)s %(message)s'
            },
        },
        'filters': { 
            'require_debug_false': { 
                '()': 'django.utils.log.RequireDebugFalse'
            }
        },
        'handlers': { 
            'console': { 
                'level': 'DEBUG',
                'class': 'logging.StreamHandler',
                'formatter': 'standard'
            },
            'default': { 
                'level': 'INFO',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': os.path.join(LOG_DIR, 'info.log'),
                'maxBytes': 1024*1024*50,   # 50 MB
                'backupCount': 2,
                'formatter': 'standard',
            },
            'default_debug': { 
                'level': 'DEBUG',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': os.path.join(LOG_DIR, 'debug.log'),
                'maxBytes': 1024*1024*50,  # 50 MB
                'backupCount': 2,
                'formatter': 'standard',
            },
            'request_handler': { 
                'level': 'DEBUG',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': os.path.join(LOG_DIR, 'common.log'),
                'maxBytes': 1024*1024*50,  # 50 MB
                'backupCount': 2,
                'formatter': 'standard',
            },
            'restful_api': { 
                'level': 'DEBUG',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': os.path.join(LOG_DIR, 'api.log'),
                'maxBytes': 1024*1024*50,  # 50 MB
                'backupCount': 2,
                'formatter': 'verbose',
            },
        },
        'loggers': { 
            'django': { 
                'handlers': ['console', 'default_debug'],
                'level': 'INFO',
                'propagate': False
            },
            'django.request': { 
                'handlers': ['request_handler'],
                'level': 'INFO',
                'propagate': False
            },
            'common': { 
                'handlers': ['default', 'console'],
                'level': 'INFO',
                'propagate': True
            },
            'api': { 
                'handlers': ['restful_api'],
                'level': 'INFO',
                'propagate': True
            },
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]: /images/20220829/ce7bd45eb23949c7888ded5bb6d3b343.png