Profiler Configuration Reference (WebProfilerBundle)
Profiler Configuration Reference (WebProfilerBundle)¶
The WebProfilerBundle provides detailed technical information about each request
execution and displays it in both the web debug toolbar and the
profiler. All these options are configured under the
web_profiler key in your application configuration.
1 2 3 4 5 | # displays the default config values defined by Symfony
$ php bin/console config:dump-reference web_profiler
# displays the actual config values used by your application
$ php bin/console debug:config web_profiler
|
Note
When using XML, you must use the http://symfony.com/schema/dic/webprofiler
namespace and the related XSD schema is available at:
https://symfony.com/schema/dic/webprofiler/webprofiler-1.0.xsd
Caution
The web debug toolbar is not available for responses of type StreamedResponse.
Configuration¶
toolbar¶
type: boolean default: false
It enables and disables the toolbar entirely. Usually you set this to true
in the dev and test environments and to false in the prod
environment.
position¶
Deprecated since version 3.4: The position option was deprecated in Symfony 3.4 and will be removed
in Symfony 4.0, where the toolbar is always displayed in the bottom position.
type: string default: bottom
It defines the location of the browser window where the toolbar is displayed.
the only allowed values are bottom and top.
intercept_redirects¶
type: boolean default: false
If a redirect occurs during an HTTP response, the browser follows it automatically and you won't see the toolbar or the profiler of the original URL, only the redirected URL.
When setting this option to true, the browser stops before making any
redirection and shows you the URL which is going to redirect to, its toolbar,
and its profiler. Once you've inspected the toolbar/profiler data, you can click
on the given link to perform the redirect.
excluded_ajax_paths¶
type: string default: '^/(app(_[\\w]+)?\\.php/)?_wdt'
When the toolbar logs AJAX requests, it matches their URLs against this regular expression. If the URL matches, the request is not displayed in the toolbar. This is useful when the application makes lots of AJAX requests, or if they are heavy and you want to exclude some of them.
verbose¶
type: boolean default: true
This option is deprecated and has no effect on the toolbar or the profiler, so you can safely remove it from your configuration.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.