From 68f7f25788b7f223788f2f221cd91d75c6a79001 Mon Sep 17 00:00:00 2001 From: adamscmRH Date: Thu, 7 Jun 2018 11:07:15 -0400 Subject: [PATCH] info to set ip DDT --- docs/debugging.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/debugging.md b/docs/debugging.md index 1257a8cf11..475b5cffae 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -1,6 +1,20 @@ Debugging ========= +Django Debug Toolbar (DDT) +---------------- +This is a useful tool for examining SQL queries, performance, headers, requests, signals, cache, logging, and more. + +To enable DDT, you need to set your INTERNAL_IPS to the IP address of your load balancer. This can be overriden in `local_settings`. +This IP address can be found by making a GET to any page on the browsable API and looking for a like this in the standard output. +``` +awx_1 | 14:42:08 uwsgi.1 | 172.18.0.1 GET /api/v2/tokens/ - HTTP/1.1 200 +``` + +Whitelist this IP address by adding it to the INTERNAL_IPS variable in local_settings, then navigate to the API and you should see DDT on the +right side. If you don't see it, make sure `DEBUG=True`. +> Note that enabling DDT is detrimental to the performance of AWX and adds overhead to every API request. It is +recommended to keep this turned off when you are not using it. Remote Debugging