From f7538d1f6623fd33644bdb6cc393e8aaa32e6aed Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Mon, 24 Sep 2018 08:21:38 +0200 Subject: [PATCH] tweaked documentation about the profiler --- profiler.rst | 8 ++-- profiler/storage.rst | 50 ------------------------ reference/configuration/framework.rst | 5 --- reference/configuration/web_profiler.rst | 8 ++-- 4 files changed, 9 insertions(+), 62 deletions(-) delete mode 100644 profiler/storage.rst diff --git a/profiler.rst b/profiler.rst index a2dcc24e2b2..6deabbe4703 100644 --- a/profiler.rst +++ b/profiler.rst @@ -1,8 +1,11 @@ Profiler ======== -Symfony provides a powerful profiler to get detailed information about the -execution of any request. +The profiler is a powerful **development tool** that gives detailed information +about the execution of any request. + +**Never** enable the profiler in production environments as it will lead to +major security vulnerabilities in your project. Installation ------------ @@ -20,5 +23,4 @@ install the profiler before using it: profiler/data_collector profiler/profiling_data profiler/matchers - profiler/storage profiler/wdt_follow_ajax diff --git a/profiler/storage.rst b/profiler/storage.rst deleted file mode 100644 index fc9d31d528b..00000000000 --- a/profiler/storage.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. index:: - single: Profiling; Storage Configuration - -Switching the Profiler Storage -============================== - -The profiler stores the collected data in the ``%kernel.cache_dir%/profiler/`` -directory. If you want to use another location to store the profiles, define the -``dsn`` option of the ``framework.profiler``: - -.. configuration-block:: - - .. code-block:: yaml - - # config/packages/dev/web_profiler.yaml - framework: - profiler: - dsn: 'file:/tmp/symfony/profiler' - - .. code-block:: xml - - - - - - - - - - - .. code-block:: php - - // config/packages/dev/web_profiler.php - - // ... - $container->loadFromExtension('framework', array( - 'profiler' => array( - 'dsn' => 'file:/tmp/symfony/profiler', - ), - )); - -You can also create your own profile storage service implementing the -:class:`Symfony\\Component\\HttpKernel\\Profiler\\ProfilerStorageInterface` and -overriding the ``profiler.storage`` service. diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index c6bcecc247a..e4e36fa2c2b 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -620,11 +620,6 @@ dsn The DSN where to store the profiling information. -.. seealso:: - - See :doc:`/profiler/storage` for more information about the - profiler storage. - request ~~~~~~~ diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index 651de5c1159..f6cf31ca393 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -4,10 +4,10 @@ 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 -:doc:`profiler `. All these options are configured under the -``web_profiler`` key in your application configuration. +The WebProfilerBundle is a **development tool** that provides detailed technical +information about each request execution and displays it in both the web debug +toolbar and the :doc:`profiler `. All these options are configured +under the ``web_profiler`` key in your application configuration. .. code-block:: terminal