1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
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_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: ``{'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.2.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 to ``True``, 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
to ``True`` and the IP of the request must be in ``INTERNAL_IPS``. You can
provide your own function ``callback(request)`` which returns ``True`` or
``False``.
For versions < 1.8, the callback should also return ``False`` for AJAX
requests. Since version 1.8, AJAX requests are checked in the middleware, not
the callback. This allows reusing the callback to verify access to panel
views requested via AJAX.
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 is ``socketserver`` on Python 3 and
``SocketServer`` 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.
* ``SKIP_TEMPLATE_PREFIXES``
Default: ``('django/forms/widgets/', 'admin/widgets/')``
Panel: templates.
Templates starting with those strings are skipped when collecting
rendered templates and contexts. Template-based form widgets are
skipped by default because the panel HTML can easily grow to hundreds
of megabytes with many form fields and many options.
* ``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
}
|
