External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-02-02 10:08:10 -03:30
Code Issues Packages Projects Releases Wiki Activity

add docs for debugging slow api endpoint

Browse Source
This commit is contained in:
Chris Meyers
2021-08-25 09:04:51 -04:00
parent e7dbe90cb5
commit 8e043b139a
2 changed files with 27 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/debugging/debugging_misc.md
View File

@@ -1,21 +1,6 @@
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 overridden by creating a new settings file beginning with `local_` in `awx/settings/` (e.g. `local_overrides.py`).
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
```
Allow this IP address by adding it to the `INTERNAL_IPS` variable in your new override local settings file, then navigate to the API and you should see DDT on the
right side. If you don't see it, make sure to set `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.
SQL Debugging
-------------
AWX includes a powerful tool for tracking slow queries across all of its Python processes.