]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/Profiler.php
Fixed max value check, improved request value fetching
[friendica.git] / src / Util / Profiler.php
index c8c56337180fd04100e1f3673c994bf08efde667..24289678c266a41450b751fff3b6132ff8355cd7 100644 (file)
@@ -1,7 +1,29 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Util;
 
+use Friendica\Core\Config\ValueObject\Cache;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\System;
 use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
@@ -11,7 +33,7 @@ use Psr\Log\LoggerInterface;
  * A class to store profiling data
  * It can handle different logging data for specific functions or global performance measures
  *
- * It stores the data as log entries (@see LoggerInterface )
+ * It stores the data as log entries (@see LoggerInterface)
  */
 class Profiler implements ContainerInterface
 {
@@ -32,6 +54,8 @@ class Profiler implements ContainerInterface
         */
        private $rendertime;
 
+       private $timestamps = [];
+
        /**
         * True, if the Profiler should measure the whole rendertime including functions
         *
@@ -43,23 +67,86 @@ class Profiler implements ContainerInterface
        }
 
        /**
-        * @param bool $enabled           True, if the Profiler is enabled
-        * @param bool $renderTime        True, if the Profiler should measure the whole rendertime including functions
+        * Updates the enabling of the current profiler
+        *
+        * @param IManageConfigValues $config
+        */
+       public function update(IManageConfigValues $config)
+       {
+               $this->enabled = $config->get('system', 'profiler');
+               $this->rendertime = $config->get('rendertime', 'callstack');
+       }
+
+       /**
+        * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache
         */
-       public function __construct($enabled = false, $renderTime = false)
+       public function __construct(Cache $configCache)
        {
-               $this->enabled = $enabled;
-               $this->rendertime = $renderTime;
+               $this->enabled = $configCache->get('system', 'profiler');
+               $this->rendertime = $configCache->get('rendertime', 'callstack');
                $this->reset();
        }
 
+       /**
+        * Start a profiler recording
+        *
+        * @param string $value
+        * @return void
+        */
+       public function startRecording(string $value)
+       {
+               if (!$this->enabled) {
+                       return;
+               }
+
+               $this->timestamps[] = ['value' => $value, 'stamp' => microtime(true), 'credit' => 0];
+       }
+
+       /**
+        * Stop a profiler recording
+        *
+        * @param string $callstack
+        * @return void
+        */
+       public function stopRecording(string $callstack = '')
+       {
+               if (!$this->enabled || empty($this->timestamps)) {
+                       return;
+               }
+
+               $timestamp = array_pop($this->timestamps);
+
+               $duration = floatval(microtime(true) - $timestamp['stamp'] - $timestamp['credit']);
+               $value = $timestamp['value'];
+
+               foreach ($this->timestamps as $key => $stamp) {
+                       $this->timestamps[$key]['credit'] += $duration;
+               }
+
+               $callstack = $callstack ?: System::callstack(4, $value == 'rendering' ? 0 : 1);
+
+               if (!isset($this->performance[$value])) {
+                       $this->performance[$value] = 0;
+               }
+
+               $this->performance[$value] += (float) $duration;
+               $this->performance['marktime'] += (float) $duration;
+
+               if (!isset($this->callstack[$value][$callstack])) {
+                       // Prevent ugly E_NOTICE
+                       $this->callstack[$value][$callstack] = 0;
+               }
+
+               $this->callstack[$value][$callstack] += (float) $duration;
+       }
+
        /**
         * Saves a timestamp for a value - f.e. a call
         * Necessary for profiling Friendica
         *
-        * @param int $timestamp the Timestamp
-        * @param string $value A value to profile
-        * @param string $callstack The callstack of the current profiling data
+        * @param int    $timestamp the Timestamp
+        * @param string $value     A value to profile
+        * @param string $callstack A callstack string, generated if absent
         */
        public function saveTimestamp($timestamp, $value, $callstack = '')
        {
@@ -67,7 +154,9 @@ class Profiler implements ContainerInterface
                        return;
                }
 
-               $duration = (float) (microtime(true) - $timestamp);
+               $callstack = $callstack ?: System::callstack(4, 1);
+
+               $duration = floatval(microtime(true) - $timestamp);
 
                if (!isset($this->performance[$value])) {
                        // Prevent ugly E_NOTICE
@@ -101,6 +190,7 @@ class Profiler implements ContainerInterface
        {
                $this->performance = [];
                $this->performance['start'] = microtime(true);
+               $this->performance['ready'] = 0;
                $this->performance['database'] = 0;
                $this->performance['database_write'] = 0;
                $this->performance['cache'] = 0;
@@ -108,9 +198,13 @@ class Profiler implements ContainerInterface
                $this->performance['network'] = 0;
                $this->performance['file'] = 0;
                $this->performance['rendering'] = 0;
-               $this->performance['parser'] = 0;
+               $this->performance['session'] = 0;
                $this->performance['marktime'] = 0;
                $this->performance['marktime'] = microtime(true);
+               $this->performance['classcreate'] = 0;
+               $this->performance['classinit'] = 0;
+               $this->performance['init'] = 0;
+               $this->performance['content'] = 0;
        }
 
        /**
@@ -126,15 +220,16 @@ class Profiler implements ContainerInterface
                $this->callstack['network'] = [];
                $this->callstack['file'] = [];
                $this->callstack['rendering'] = [];
-               $this->callstack['parser'] = [];
+               $this->callstack['session'] = [];
        }
 
        /**
         * Returns the rendertime string
+        * @param float $limit Minimal limit for displaying the execution duration
         *
         * @return string the rendertime
         */
-       public function getRendertimeString()
+       public function getRendertimeString(float $limit = 0)
        {
                $output = '';
 
@@ -146,7 +241,7 @@ class Profiler implements ContainerInterface
                        $output .= "\nDatabase Read:\n";
                        foreach ($this->callstack["database"] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
+                               if ($time > $limit) {
                                        $output .= $func . ": " . $time . "\n";
                                }
                        }
@@ -155,7 +250,7 @@ class Profiler implements ContainerInterface
                        $output .= "\nDatabase Write:\n";
                        foreach ($this->callstack["database_write"] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
+                               if ($time > $limit) {
                                        $output .= $func . ": " . $time . "\n";
                                }
                        }
@@ -164,7 +259,7 @@ class Profiler implements ContainerInterface
                        $output .= "\nCache Read:\n";
                        foreach ($this->callstack["cache"] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
+                               if ($time > $limit) {
                                        $output .= $func . ": " . $time . "\n";
                                }
                        }
@@ -173,7 +268,7 @@ class Profiler implements ContainerInterface
                        $output .= "\nCache Write:\n";
                        foreach ($this->callstack["cache_write"] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
+                               if ($time > $limit) {
                                        $output .= $func . ": " . $time . "\n";
                                }
                        }
@@ -182,7 +277,17 @@ class Profiler implements ContainerInterface
                        $output .= "\nNetwork:\n";
                        foreach ($this->callstack["network"] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
+                               if ($time > $limit) {
+                                       $output .= $func . ": " . $time . "\n";
+                               }
+                       }
+               }
+
+               if (isset($this->callstack["rendering"])) {
+                       $output .= "\nRendering:\n";
+                       foreach ($this->callstack["rendering"] as $func => $time) {
+                               $time = round($time, 3);
+                               if ($time > $limit) {
                                        $output .= $func . ": " . $time . "\n";
                                }
                        }
@@ -242,6 +347,11 @@ class Profiler implements ContainerInterface
                }
        }
 
+       public function set($timestamp, $id)
+       {
+               $this->performance[$id] = $timestamp;
+       }
+
        /**
         * Returns true if the container can return an entry for the given identifier.
         * Returns false otherwise.