diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index bfbd4c75a44..2512142b239 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -4,6 +4,71 @@ WebProfilerBundle Configuration ("web_profiler") ================================================ +The WebProfilerBundle provides detailed technical information about each request +execution and displays it in both the web debug toolbar and the profiler. + +.. caution:: + + The web debug toolbar is not available for responses of type ``StreamedResponse``. + +Configuration +------------- + +* `toolbar`_ +* `position`_ +* `intercept_redirects`_ +* `excluded_ajax_paths`_ +* `verbose`_ + +toolbar +~~~~~~~ + +**type**: ``boolean`` **default**: ``true`` + +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 +~~~~~~~~ + +**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 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. + Full Default Configuration -------------------------- @@ -13,23 +78,14 @@ Full Default Configuration # app/config/config.yml web_profiler: - - # DEPRECATED, it is not useful anymore and can be removed - # safely from your configuration - verbose: true - - # display the web debug toolbar at the bottom of pages with - # a summary of profiler info toolbar: false position: bottom - - # gives you the opportunity to look at the collected data - # before following the redirect - intercept_redirects: false - - # Exclude AJAX requests in the web debug toolbar for specified paths + intercept_redirects: false excluded_ajax_paths: ^/bundles|^/_wdt + # DEPRECATED, it can be removed safely from your configuration + verbose: true + .. code-block:: xml