Django + debug_toolbar 사용하기 (+ Docker 환경에 추가)

🎈 Django + debug toolbar 사용하기

🎈 Docker 환경에서 Django + debug toolbar 사용하기

1. Django + debug toolbar 사용하기

 

✔️참고: https://django-debug-toolbar.readthedocs.io/en/latest/installation.html

 

poetry add django-debug-toolbar

또는

pip install django-debug-toolbar

 

Installed-Apps 에     "django.contrib.staticfiles" 이 들어있는지 확인 (디폴트로 들어가 있음)

 

✏️ STATIC_URL = "static/" 있는지 확인

 

INSTALLED_APPS = [
    # ...
    "django.contrib.staticfiles",
    # ...
]

 

✏️ TEMPLATES 확인

 

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "APP_DIRS": True,
        # ...
    }
]

 

✏️ INSTALLED_APPS에 debug_toolbar 추가

 

INSTALLED_APPS = [
    # ...
    "debug_toolbar",
    # ...
]

 

✏️ 루트앱  urls.py 에 아래 주소 추가 

 

# config/urls.py

from django.urls import include, path

urlpatterns = [
    # ...
    path('__debug__/', include('debug_toolbar.urls')),
]

 

✏️ 미들웨어 추가

 

MIDDLEWARE = [
    # ...
    "debug_toolbar.middleware.DebugToolbarMiddleware",
    # ...
]

 

 

✏️ INTERNAL_IPS 추가

 

INTERNAL_IPS = ['127.0.0.1']

 

아마 Docker 환경이 아니라면 127.0.0.1:8000 으로 접속했을 때 Debug toolbar 가 잘 보일 거에요

 

But... 1번과 같은 방법으로 세팅을 해도 Docker 환경에서는 debug tool bar가 보이지 않습니다. 

 

 

💡 왜 Docker  환경에서는 debug tool bar 가 보이지 않을까요..?

 

✔️ 참고 Django Debug Toolbar not showing up when using Docker — Django & Docker

https://ranjanmp.medium.com/django-debug-toolbar-not-showing-up-when-using-docker-django-docker-e79585813bc6

Django Debug Toolbar not showing up when using Docker — Django & Docker

 

- INTERNAL_IPS 는요...

 

Debug toolbar 는 INTERNAL_IPS 라는 설정이 있습니다.

Debug toolbar 는 유저가 접근하려는 애플리케이션 IP 주소가 INTERNAL_IPS 에 등록된 경우에만 나타나게 됩니다.

이건 보안적 측면에서 다른 IP 주소가 Debug toolbar 에 접근하지 못하게 하기 위해서 인데요.

개발자는 INTERNAL_IPS 에 IP주소를 추가해서 Debug toolbar에 접근할 수 있어요.

로컬 개발환경에서 INTERNAL_IPS 는 ['127.0.0.1']로 세팅되어 있어야 합니다.

 

- 그래서 왜 Docker환경에서는 안 보이는데요...

 

각각의 Docker 컨테이너는 Docker bridge network로부터 IP 주소를 할당 받게됩니다.

여러개의 멀티 컨테이너가 docker-compose를 통해 실행될 때, docker-compose 내에 있는 모든 애플리케이션들을 위해 기본 서브넷 마스크와 게이트웨이로 새로운 네트워크가 생성됩니다.

이 새로운 네트워크는 기본적으로 '<폴더이름>_default' 라는 이름을 갖게 되는데요, 만약 네트워크 이름이 docker-compose 파일에 명시되어 있지 않으면 '<폴더이름>'은 docker-compose 파일 내의 폴더, 디렉터리 이름 중 하나가 됩니다.

컨테이너의 요청(request)는 Docker bridge network 의 게이트웨이를 통하게 됩니다. (docker-compose 를 사용할 경우..)

로컬 호스트에서 시작된 요청은 네트워크의 게이트웨이를 통해 전달되므로 Django 애플리케이션은 요청받은 IP 주소를 Docker 네트워크의 게이트웨이 IP 주소로 인식하게 됩니다. 결국 로컬에서 개발중일 때 INTERNAL_IPS를 ["127.0.0.1"] 이라고 설정하더라도 Debug toolbar가 나타나지 않는 이유입니다. (게이트웨이 주소는 127.0.0.1이 아니니까요...)

 

즉, 게이트웨이의 IP 주소를 INTERNAL_IPS에 추가하면 Debug toolbar 는 보이게 될거에요.

하지만 이렇게 하드코딩하는 방식은 추천하지 않습니다. 

왜냐하면 게이트웨이 IP 주소는 새로운 이미지가 빌드되고, 컨테이너가 중지되고, 삭제되고, 다시 시작될 때마다 바뀔 수 있기 때문이에요. 

 

2. Docker 환경에서 debug tool bar  사용하기

 

✔️ Prerequisite

- Static, Template, Middleware, url.py 의 설정은 1번과 같이 마쳤다는 전제 하에 INTERNAL_IPS 만 변경해 볼게요!

 

# settings.py

INTERNAL_IPS = ['127.0.0.1'] # 기존의 INTERNAL_IPS

if DEBUG:    
    import socket
    hostname, _, ips =socket.gethostbyname_ex(socket.gethostname())
    INTERNAL_IPS += [ip[:-1] + '1' for ip in ips]

 

hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())

=> 호스트 머신의 IP 주소를 ips 파라미터에 리턴합니다

[ip[:-1] + '1' for ip in ips]

=> 호스트 IP 주소의 마지막 한 자리를 제거하고 1로 대체합니다.

예를 들어 호스트 머신의 IP 주소가 172.17.0.3 일 경우, Docker 네트워크의 게이트웨이 IP 주소는 항상 172.17.0.1이 되기 때문이에요.

 

print(INTERNAL_IPS) 를 출력해보았습니다.

기존의 '127.0.0.1' 에 게이트웨이 IP 주소가 추가되어 출력되는 걸 볼 수 있습니다.

 

그리고... 

 

 Debug toolbar 가 잘 나오는 걸 볼 수 있답니당 👏👏👏

 

 

제가 한 방식으로도 잘 안 된다면 아래 참고 링크들도 확인해 보세요><

 

✔️ 참고 django_debug_toolbar and Docker

https://stackoverflow.com/questions/26898597/django-debug-toolbar-and-docker

✔️ 참고 Fix: Django Debug Toolbar not showing when using with Docker.

https://gist.github.com/douglasmiranda/9de51aaba14543851ca3