44WebProfilerBundle Configuration ("web_profiler")
55================================================
66
7+ The WebProfilerBundle provides detailed technical information about each request
8+ execution and displays it in both the web debug toolbar and the profiler.
9+
10+ .. caution ::
11+
12+ The web debug toolbar is not available for responses of type ``StreamedResponse ``.
13+
14+ Configuration
15+ -------------
16+
17+ * `toolbar `_
18+ * `position `_
19+ * `intercept_redirects `_
20+ * `excluded_ajax_paths `_
21+ * `verbose `_
22+
23+ toolbar
24+ ~~~~~~~
25+
26+ **type **: ``boolean `` **default **: ``true ``
27+
28+ It enables and disables the toolbar entirely. Usually you set this to ``true ``
29+ in the ``dev `` and ``test `` environments and to ``false `` in the ``prod ``
30+ environment.
31+
32+ position
33+ ~~~~~~~~
34+
35+ **type **: ``string `` **default **: ``bottom ``
36+
37+ It defines the location of the browser window where the toolbar is displayed.
38+ the only allowed values are ``bottom `` and ``top ``.
39+
40+ intercept_redirects
41+ ~~~~~~~~~~~~~~~~~~~
42+
43+ **type **: ``boolean `` **default **: ``false ``
44+
45+ If a redirect occurs during an HTTP response, the browser follows it automatically
46+ and you won't see the toolbar or the profiler of the original URL, only the
47+ redirected URL.
48+
49+ When setting this option to ``true ``, the browser *stops * before making any
50+ redirection and shows you the URL which is going to redirect to, its toolbar,
51+ and its profiler. Once you've inspected the toolbar/profiler data, you can click
52+ on the given link to perform the redirect.
53+
54+ excluded_ajax_paths
55+ ~~~~~~~~~~~~~~~~~~~
56+
57+ **type **: ``string `` **default **: ``'^/(app(_[\\w]+)?\\.php/)?_wdt' ``
58+
59+ When the toolbar logs Ajax requests, it matches their URLs against this regular
60+ expression. If the URL matches, the request is not displayed in the toolbar. This
61+ is useful when the application makes lots of Ajax requests or they are heavy and
62+ you want to exclude some of them.
63+
64+ verbose
65+ ~~~~~~~
66+
67+ **type **: ``boolean `` **default **: ``true ``
68+
69+ This option is **deprecated ** and has no effect on the toolbar or the profiler,
70+ so you can safely remove it from your configuration.
71+
772Full Default Configuration
873--------------------------
974
@@ -13,23 +78,14 @@ Full Default Configuration
1378
1479 # app/config/config.yml
1580 web_profiler :
16-
17- # DEPRECATED, it is not useful anymore and can be removed
18- # safely from your configuration
19- verbose : true
20-
21- # display the web debug toolbar at the bottom of pages with
22- # a summary of profiler info
2381 toolbar : false
2482 position : bottom
25-
26- # gives you the opportunity to look at the collected data
27- # before following the redirect
28- intercept_redirects : false
29-
30- # Exclude AJAX requests in the web debug toolbar for specified paths
83+ intercept_redirects : false
3184 excluded_ajax_paths : ^/bundles|^/_wdt
3285
86+ # DEPRECATED, it can be removed safely from your configuration
87+ verbose : true
88+
3389 .. code-block :: xml
3490
3591 <!-- app/config/config.xml -->
0 commit comments