[Django] django-debug-toolbar 설치하기

프로그래밍에서 디버깅은 땔래야 땔 수 없는 중요한 요소입니다. django 에서도 마찬가지 입니다. 그래서 저번에 vs code 를 이용하여 django 에서 디버깅하는 방법을 포스팅하기도 했었습니다.

 

이번에는 django-debug-toolbar 를 소개해드리겠습니다. django에서만 사용가능하며, 현재 서버와 클라이언트 간의 request, response 등 다양한 정보를 브라우저에서 쉽게 확인할 수 있습니다. 이를 통해 header, sql. static, cache 등 여러 정보 역시 확인할 수 있습니다.

보다 더 자세한 내용은 django-debug-toolbar 의 공식 문서 를 확인해주시고 간단히 설치방법을 알아보도록 하겠습니다.

django-debug-toolbar 설치

pip install django-debug-toolbar

pip 를 이용해서 django-debug-toolbar 를 install 합니다.

 

settings.py 설정

INSTALLED_APPS = [
  # 생략
  'django.contrib.staticfiles',
  'debug_toolbar',
]

앱을 추가해줍니다. django.contrib.staticfiles 는 기존에 존재하지만 필요하기 때문에 기재하였습니다.

MIDDLEWARE = [
    # 생략
    'debug_toolbar.middleware.DebugToolbarMiddleware',
]

debug-toolbar 는 대부분 미들웨어로 구현되기 때문에 미들웨어에서 활성화를 시켜야합니다.

STATIC_URL = '/static/'

마찬가지로 이미 존재하지만 필요하기 때문에 기재하였습니다.

INTERNAL_IPS = [
    '127.0.0.1',
]

해당 IP 주소에서는 django-debug-toolbar 이용이 가능합니다. 로컬에서 디버깅할 때만 필요하기 때문에, 127.0.0.1 만 넣어두었지만 필요에 의해 여러 IP 를 추가할 수 있습니다.

 

urls.py 설정

# project/urls.py

from django.conf import settings
from django.urls import include, path

urlpatterns = [
  # 생략
]

if settings.DEBUG:
    import debug_toolbar
    urlpatterns += [
        path('__debug__/', include(debug_toolbar.urls)),
    ]

다른 앱의 urls을 include 하는 것 처럼 이미 구현되어 있는 debug 의 url 들을 추가해줍니다. 이는 settings.DEBUG 을 통해서 개발 중일 때만 확인하도록 합니다.

그 후 서버를 돌리면 브라우저 오른쪽에 django-debug-toolbar 가 생겼음을 확인할 수 있습니다.