[Django] Django Rest Framework에서 request 로깅하기

drf-tracking

https://github.com/aschn/drf-tracking

# 설치

drf-tracking 설치

$ pip install drf-tracking

settings.py의 INSTALLED_APPS에 'rest_framework_tracking' 추가

그리고 APIRequestLog 모델 생성 위해 마이그레이션 실행

$ python manage.py migrate

# 사용

view가 실행될 때마다 APIRequestLog 인스턴스를 생성하기 위해, views.py에 rest_framework_tracking.mixins.LoggingMixin 추가한다.

request를 로깅하고 싶은 클래스에 LoggingMixin를 넣어주면 된다.

# views.py

from rest_framework import generics
from rest_framework.response import Response
from rest_framework_tracking.mixins import LoggingMixin

class SampleView(LoggingMixin):
    def get(self, request):
        return Response('with logging')

# 장점

뷰의 클래스에 LoggingMixin만 넣어주면 request가 실행되는 즉시 실행시간, 에러 여부, 상태 코드, 실행 유저 등의 정보들이 APIRequestLog 모델에 저장된다. 모든 모델 필드를 보고 싶다면 여기로. 

# 단점

Class Based View를 써야 한다. GitHub 이슈를 보니 누군가 2017년에 Function Based View로 쓸 수 없냐고 묻긴 했는데 아직까지도 별다른 업데이트가 없다.

---

django-request-logging

https://github.com/Rhumbix/django-request-logging

# 설치

django-request-logging 모듈을 설치한다.

$ pip install django-request-logging

# 사용

settings.py의 MIDDLEWARE에 'request_logging.middleware.LoggingMiddleware'를 추가한다.

MIDDLEWARE = (
    ...,
    'request_logging.middleware.LoggingMiddleware',
    ...,
)

그리고 로깅 환경을 설정해준다. 참고로 handler를 수정하여 파일에 저장할 수도 있다.

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
        },
    },
    'loggers': {
        'django.request': {
            'handlers': ['console'],
            'level': 'DEBUG',  # change debug level as appropiate
            'propagate': False,
        },
    },
}

결과는 대강 이렇게 나온다.

GET /api/get-user/?format=api

{'HTTP_HOST': '127.0.0.1:8000', 'HTTP_CONNECTION': 'keep-alive', 'HTTP_UPGRADE_INSECURE_REQUESTS': '1', 'HTTP_DNT': '1', 'HTTP_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36', 'HTTP_ACCEPT': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8', 'HTTP_REFERER': 'http://127.0.0.1:8000/api/get-user/', 'HTTP_ACCEPT_ENCODING': 'gzip, deflate, br', 'HTTP_ACCEPT_LANGUAGE': 'ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7', 'HTTP_COOKIE': 'csrftoken=N3BGmHB4aQZKeQwvsy7iq2OSZ9luz3xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; jenkins-timestamper-offset=-32400000'}

GET /api/get-user/?format=api - 200

# 장점

알록달록함

# 단점

내게 필요한 데이터가 부족함