Extract the profiler to a new component

jelte · jelte · commit 8995be16d406 · 2015-08-19T13:14:54.000+02:00
diff --git a/components/map.rst.inc b/components/map.rst.inc
@@ -115,6 +115,10 @@
 
   * :doc:`/components/process`
 
+* :doc:`/components/profiler/index`
+
+    * :doc:`/components/profiler/introduction`
+
 * :doc:`/components/property_access/index`
 
   * :doc:`/components/property_access/introduction`
diff --git a/components/profiler/introduction.rst b/components/profiler/introduction.rst
@@ -32,21 +32,21 @@ Enabling them all is as easy as it can get::
     $profiler = new Profiler($storage);
 
     // $profile is an implementation of ProfileInterface.
-    $profile = $profiler->profile($profile);
-
-    $profiler->save($profile);
-
-Shortcuts are provided to profile HTTP Requests and Console Commands::
-
-    // Profile an HTTP Request & Repsonse
-    $profiler->profileRequest($request, $response);
-
-    // Profile a Console Command
-    $profiler->profileCommand($command, $input, $exitCode);
+    $profile = $profiler->profile();
+
+    $profiler->save(
+        $profile,
+        array(
+            'url' => http://localhost/',
+            'ip' => '127.0.0.1',
+            'method' => 'GET',
+            'response_code' => 200,
+            'profile_type' => 'http',
+        )
+    );
 
 if your project makes use of the :doc:`EventDispatcher component </components/event_dispatcher/introduction>`, you can automate the profiling by using the corresponding
-EventListeners :class:`Symfony\\Component\\Profiler\\EventListener\\HttpProfilerListener` and
-:class:`Symfony\\Component\\Profiler\\EventListener\\ConsoleProfilerListener`.
+EventListeners :class:`Symfony\\Component\\Profiler\\EventListener\\HttpProfilerListener`.
 
 .. caution::
 
diff --git a/cookbook/profiler/data_collector.rst b/cookbook/profiler/data_collector.rst
@@ -17,61 +17,40 @@ Creating a custom data collector is as simple as implementing the
     interface DataCollectorInterface
     {
         /**
-         * Set the Token of the active profile.
+         * Returns the collected data.
          *
-         * @param $token
-         */
-        public function setToken($token);
-
-        /**
-         * Returns the name of the collector.
+         * @return ProfileDataInterface
          *
-         * @return string The collector name
+         * @todo introduce in 3.0
          */
-        function getName();
+        public function getCollectedData();
     }
 
-The ``getName()`` method must return a unique name. This is used to access the
-information later on (see :doc:`/cookbook/testing/profiling` for
-instance).
-
-And implementing either the :class:`Symfony\\Component\\Profiler\\DataCollector\\RuntimeDataCollectorInterface`::
+if the data should be collected just prior to the Profile being saved add the :class:`Symfony\\Component\\Profiler\\DataCollector\\LateDataCollectorInterface`::
 
-    interface RuntimeDataCollectorInterface
+    interface LateDataCollectorInterface
     {
-        /**
-         * Collects data when profiler is triggered.
-         *
-         * @return ProfileDataInterface
-         */
-        public function collect();
     }
 
-or the :class:`Symfony\\Component\\Profiler\\DataCollector\\LateDataCollectorInterface`::
+The ``getCollectedData()`` method is responsible for storing the data it wants to give
+access to in a :class:`Symfony\\Component\\Profiler\\ProfileData\\ProfileDataInterface`::
 
-    interface LateDataCollectorInterface
+    interface ProfileDataInterface extends \Serializable
     {
-        /**
-         * Collects data as late as possible.
-         *
-         * @return ProfileDataInterface
-         */
-        public function lateCollect();
+        public function getName();
     }
 
-The ``collect()`` or ``lateCollect()`` method is responsible for storing the data it wants to give
-access to in a :class:`Symfony\\Component\\Profiler\\ProfileData\\ProfileDataInterface`.
+The ``getName()`` method must return a unique name. This is used to access the
+information later on (see :doc:`/cookbook/testing/profiling` for
+instance).
 
 .. caution::
 
     As the profiler serializes ProfileData instances, you should not
     store objects that cannot be serialized (like PDO objects), or you need
     to provide your own ``serialize()`` method.
 
-Most of the time, it is convenient to extend
-:class:`Symfony\\Component\\Profiler\\DataCollector\\AbstractDataCollector` which already implements
-:class:`Symfony\\Component\\Profiler\\DataCollector\\DataCollectorInterface` and `setToken($token)` the only thing
-left to do is to decide when the data is collected::
+Example DataCollector::
 
     class MemoryDataCollector extends AbstractDataCollector implements LateDataCollectorInterface
     {
@@ -92,14 +71,6 @@ left to do is to decide when the data is collected::
         {
             return new MemoryData(memory_get_peak_usage(true), $this->memoryLimit);
         }
-
-        /**
-         * {@inheritdoc}
-         */
-        public function getName()
-        {
-            return 'memory';
-        }
     }
 
     class MemoryData implements ProfileDataInterface
@@ -119,6 +90,14 @@ left to do is to decide when the data is collected::
             $this->memoryLimit = $this->convertToBytes($memoryLimit);
         }
 
+        /**
+         * {@inheritdoc}
+         */
+        public function getName()
+        {
+            return 'memory';
+        }
+
         /**
          * Returns the memory.
          *
@@ -143,6 +122,8 @@ left to do is to decide when the data is collected::
     }
 
 
+
+
 .. _data_collector_tag:
 
 Enabling custom Data Collectors
diff --git a/cookbook/profiler/profiling_data.rst b/cookbook/profiler/profiling_data.rst
@@ -6,44 +6,37 @@ How to Access Profiling Data Programmatically
 
 Most of the times, the profiler information is accessed and analyzed using its
 web-based visualizer. However, you can also retrieve profiling information
-programmatically thanks to the methods provided by the ``profiler`` service.
-
-When the response object is available, use the
-:method:`Symfony\\Component\\Profiler\\Profiler::loadFromResponse`
-method to access to its associated profile::
-
-    // ... $profiler is the 'profiler' service
-    $profile = $profiler->loadFromResponse($response);
+programmatically thanks to the methods provided by the ``profiler.storage`` service.
 
 When the profiler stores data about a request, it also associates a token with it;
 this token is available in the ``X-Debug-Token`` HTTP header of the response.
 Using this token, you can access the profile of any past response thanks to the
-:method:`Symfony\\Component\\Profiler\\Profiler::load` method::
+:method:`Symfony\\Component\\Profiler\\Storage\\ProfilerStorageInterface::read` method::
 
     $token = $response->headers->get('X-Debug-Token');
-    $profile = $container->get('profiler')->load($token);
+    $profile = $container->get('profiler.storage')->read($token);
 
 .. tip::
 
     When the profiler is enabled but not the web debug toolbar, inspect the page
     with your browser's developer tools to get the value of the ``X-Debug-Token``
     HTTP header.
 
-The ``profiler`` service also provides the
-:method:`Symfony\\Component\\Profiler\\Profiler::findBy` method to
+The ``profiler.storage`` service also provides the
+:method:`Symfony\\Component\\Profiler\\Storage\\ProfilerStorageInterface::findBy` method to
 look for tokens based on some criteria::
 
     // get the latest 10 tokens
-    $tokens = $container->get('profiler')->findBy(array(), 10, '', '');
+    $tokens = $container->get('profiler.storage')->findBy(array(), 10, '', '');
 
     // get the latest 10 tokens for all URL containing /admin/
-    $tokens = $container->get('profiler')->findBy(array('url' => '/admin/'), 10, '', '');
+    $tokens = $container->get('profiler.storage')->findBy(array('url' => '/admin/'), 10, '', '');
 
     // get the latest 10 tokens for local requests
-    $tokens = $container->get('profiler')->findBy(array('ip' => '127.0.0.1'), 10, '', '');
+    $tokens = $container->get('profiler.storage')->findBy(array('ip' => '127.0.0.1'), 10, '', '');
 
     // get the latest 10 tokens for requests that happened between 2 and 4 days ago
-    $tokens = $container->get('profiler')->findBy(array(), 10, '4 days ago', '2 days ago');
+    $tokens = $container->get('profiler.storage')->findBy(array(), 10, '4 days ago', '2 days ago');
 
 Lastly, if you want to manipulate profiling data on a different machine than the
 one where the information was generated, use the ``profiler:export`` and
diff --git a/cookbook/testing/profiling.rst b/cookbook/testing/profiling.rst
@@ -34,13 +34,13 @@ the ``test`` environment)::
                 // check the number of requests
                 $this->assertLessThan(
                     10,
-                    $profile->getCollector('db')->getQueryCount()
+                    $profile->get('db')->getQueryCount()
                 );
 
                 // check the time spent in the framework
                 $this->assertLessThan(
                     500,
-                    $profile->getCollector('time')->getDuration()
+                    $profile->get('time')->getDuration()
                 );
             }
         }
@@ -52,7 +52,7 @@ finish. It's easy to achieve if you embed the token in the error message::
 
     $this->assertLessThan(
         30,
-        $profile->getCollector('db')->getQueryCount(),
+        $profile->get('db')->getQueryCount(),
         sprintf(
             'Checks that query count is less than 30 (token %s)',
             $profile->getToken()
