Configuration¶
The debug toolbar provides two settings that you can add in your project’s settings module to customize its behavior.
Note
Do you really need a customized configuration?
The debug toolbar ships with a default configuration that is considered sane for the vast majority of Django projects. Don’t copy-paste blindly the default values shown below into you settings module! It’s useless and it’ll prevent you from taking advantage of better defaults that may be introduced in future releases.
DEBUG_TOOLBAR_PATCH_SETTINGS¶
This setting defines whether the toolbar will attempt to automatically adjust
your project’s settings, as described in the installation instructions. By default it has the same value as your DEBUG
setting.
DEBUG_TOOLBAR_PANELS¶
This setting specifies the full Python path to each panel that you want
included in the toolbar. It works like Django’s MIDDLEWARE_CLASSES
setting. The default value is:
DEBUG_TOOLBAR_PANELS = [
'debug_toolbar.panels.versions.VersionsPanel',
'debug_toolbar.panels.timer.TimerPanel',
'debug_toolbar.panels.settings.SettingsPanel',
'debug_toolbar.panels.headers.HeadersPanel',
'debug_toolbar.panels.request.RequestPanel',
'debug_toolbar.panels.sql.SQLPanel',
'debug_toolbar.panels.staticfiles.StaticFilesPanel',
'debug_toolbar.panels.templates.TemplatesPanel',
'debug_toolbar.panels.cache.CachePanel',
'debug_toolbar.panels.signals.SignalsPanel',
'debug_toolbar.panels.logging.LoggingPanel',
'debug_toolbar.panels.redirects.RedirectsPanel',
]
This setting allows you to:
- add built-in panels that aren’t enabled by default,
- add third-party panels,
- remove built-in panels,
- change the order of panels.
DEBUG_TOOLBAR_CONFIG¶
This dictionary contains all other configuration options. Some apply to the toolbar itself, others are specific to some panels.
Toolbar options¶
DISABLE_PANELS
Default:
set(['debug_toolbar.panels.redirects.RedirectsPanel'])
This setting is a set of the full Python paths to each panel that you want disabled (but still displayed) by default.
INSERT_BEFORE
Default:
'</body>'
The toolbar searches for this string in the HTML and inserts itself just before.
JQUERY_URL
Default:
'//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js'
URL of the copy of jQuery that will be used by the toolbar. Set it to a locally-hosted version of jQuery for offline development. Make it empty to rely on a version of jQuery that already exists on every page of your site.
RENDER_PANELS
Default:
None
If set to
False
, the debug toolbar will keep the contents of panels in memory on the server and load them on demand. If set toTrue
, it will render panels inside every page. This may slow down page rendering but it’s required on multi-process servers, for example if you deploy the toolbar in production (which isn’t recommended).The default value of
None
tells the toolbar to automatically do the right thing depending on whether the WSGI container runs multiple processes. This setting allows you to force a different behavior if needed.RESULTS_CACHE_SIZE
Default:
10
The toolbar keeps up to this many results in memory.
ROOT_TAG_EXTRA_ATTRS
Default:
''
This setting is injected in the root template div in order to avoid conflicts with client-side frameworks. For example, when using the debug toolbar with Angular.js, set this to
'ng-non-bindable'
or'class="ng-non-bindable"'
.SHOW_COLLAPSED
Default:
False
If changed to
True
, the toolbar will be collapsed by default.SHOW_TOOLBAR_CALLBACK
Default: ‘debug_toolbar.middleware.show_toolbar’
This is the dotted path to a function used for determining whether the toolbar should show or not. The default checks are that
DEBUG
must be set toTrue
, the IP of the request must be inINTERNAL_IPS
, and the request must not be an AJAX request. You can provide your own functioncallback(request)
which returnsTrue
orFalse
.
Panel options¶
EXTRA_SIGNALS
Default:
[]
Panel: signals
A list of custom signals that might be in your project, defined as the Python path to the signal.
ENABLE_STACKTRACES
Default:
True
Panels: cache, SQL
If set to
True
, this will show stacktraces for SQL queries and cache calls. Enabling stacktraces can increase the CPU time used when executing queries.HIDE_IN_STACKTRACES
Default:
('socketserver', 'threading', 'wsgiref', 'debug_toolbar', 'django')
. The first value issocketserver
on Python 3 andSocketServer
on Python 2.Panels: cache, SQL
Useful for eliminating server-related entries which can result in enormous DOM structures and toolbar rendering delays.
PROFILER_MAX_DEPTH
Default:
10
Panel: profiling
This setting affects the depth of function calls in the profiler’s analysis.
SHOW_TEMPLATE_CONTEXT
Default:
True
Panel: templates
If set to
True
then a template’s context will be included with it in the template debug panel. Turning this off is useful when you have large template contexts, or you have template contexts with lazy datastructures that you don’t want to be evaluated.SQL_WARNING_THRESHOLD
Default:
500
Panel: SQL
The SQL panel highlights queries that took more that this amount of time, in milliseconds, to execute.
Here’s what a slightly customized toolbar configuration might look like:
# This example is unlikely to be appropriate for your project.
CONFIG_DEFAULTS = {
# Toolbar options
'RESULTS_CACHE_SIZE': 3,
'SHOW_COLLAPSED': True,
# Panel options
'SQL_WARNING_THRESHOLD': 100, # milliseconds
}