]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/Profiler.php
spelling: associative
[friendica.git] / src / Util / Profiler.php
index db3e1bb97825f38f4d48cab62170377e54dc4f6b..d6262889931ce921e869f3fa307e4d152b32df09 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -21,8 +21,7 @@
 
 namespace Friendica\Util;
 
-use Friendica\Core\Config\Cache;
-use Friendica\Core\Config\IConfig;
+use Friendica\Core\Config\Capability\IManageConfigValues;
 use Friendica\Core\System;
 use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
@@ -54,46 +53,91 @@ class Profiler implements ContainerInterface
         */
        private $rendertime;
 
+       private $timestamps = [];
+
        /**
         * True, if the Profiler should measure the whole rendertime including functions
         *
         * @return bool
         */
-       public function isRendertime()
+       public function isRendertime(): bool
        {
                return $this->rendertime;
        }
 
+       public function __construct(IManageConfigValues $config)
+       {
+               $this->enabled    = (bool)$config->get('system', 'profiler') ?? false;
+               $this->rendertime = (bool)$config->get('rendertime', 'callstack') ?? false;
+               $this->reset();
+       }
+
        /**
-        * Updates the enabling of the current profiler
+        * Start a profiler recording
+        *
+        * @param string $value
         *
-        * @param IConfig $config
+        * @return void
         */
-       public function update(IConfig $config)
+       public function startRecording(string $value)
        {
-               $this->enabled = $config->get('system', 'profiler');
-               $this->rendertime = $config->get('rendertime', 'callstack');
+               if (!$this->enabled) {
+                       return;
+               }
+
+               $this->timestamps[] = ['value' => $value, 'stamp' => microtime(true), 'credit' => 0];
        }
 
        /**
-        * @param Cache $configCache The configuration cache
+        * Stop a profiler recording
+        *
+        * @param string $callstack
+        *
+        * @return void
         */
-       public function __construct(Cache $configCache)
+       public function stopRecording(string $callstack = '')
        {
-               $this->enabled = $configCache->get('system', 'profiler');
-               $this->rendertime = $configCache->get('rendertime', 'callstack');
-               $this->reset();
+               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 float  $timestamp the Timestamp
         * @param string $value     A value to profile
         * @param string $callstack A callstack string, generated if absent
+        *
+        * @return void
         */
-       public function saveTimestamp($timestamp, $value, $callstack = '')
+       public function saveTimestamp(float $timestamp, string $value, string $callstack = '')
        {
                if (!$this->enabled) {
                        return;
@@ -108,19 +152,21 @@ class Profiler implements ContainerInterface
                        $this->performance[$value] = 0;
                }
 
-               $this->performance[$value] += (float) $duration;
-               $this->performance['marktime'] += (float) $duration;
+               $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;
+               $this->callstack[$value][$callstack] += (float)$duration;
        }
 
        /**
         * Resets the performance and callstack profiling
+        *
+        * @return void
         */
        public function reset()
        {
@@ -130,45 +176,55 @@ class Profiler implements ContainerInterface
 
        /**
         * Resets the performance profiling data
+        *
+        * @return void
         */
        public function resetPerformance()
        {
-               $this->performance = [];
-               $this->performance['start'] = microtime(true);
-               $this->performance['database'] = 0;
+               $this->performance                   = [];
+               $this->performance['start']          = microtime(true);
+               $this->performance['ready']          = 0;
+               $this->performance['database']       = 0;
                $this->performance['database_write'] = 0;
-               $this->performance['cache'] = 0;
-               $this->performance['cache_write'] = 0;
-               $this->performance['network'] = 0;
-               $this->performance['file'] = 0;
-               $this->performance['rendering'] = 0;
-               $this->performance['parser'] = 0;
-               $this->performance['marktime'] = 0;
-               $this->performance['marktime'] = microtime(true);
+               $this->performance['cache']          = 0;
+               $this->performance['cache_write']    = 0;
+               $this->performance['network']        = 0;
+               $this->performance['file']           = 0;
+               $this->performance['rendering']      = 0;
+               $this->performance['session']        = 0;
+               $this->performance['marktime']       = microtime(true);
+               $this->performance['classcreate']    = 0;
+               $this->performance['classinit']      = 0;
+               $this->performance['init']           = 0;
+               $this->performance['content']        = 0;
        }
 
        /**
         * Resets the callstack profiling data
+        *
+        * @return void
         */
        public function resetCallstack()
        {
-               $this->callstack = [];
-               $this->callstack['database'] = [];
+               $this->callstack                   = [];
+               $this->callstack['database']       = [];
                $this->callstack['database_write'] = [];
-               $this->callstack['cache'] = [];
-               $this->callstack['cache_write'] = [];
-               $this->callstack['network'] = [];
-               $this->callstack['file'] = [];
-               $this->callstack['rendering'] = [];
-               $this->callstack['parser'] = [];
+               $this->callstack['cache']          = [];
+               $this->callstack['cache_write']    = [];
+               $this->callstack['network']        = [];
+               $this->callstack['file']           = [];
+               $this->callstack['rendering']      = [];
+               $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): string
        {
                $output = '';
 
@@ -176,48 +232,62 @@ class Profiler implements ContainerInterface
                        return $output;
                }
 
-               if (isset($this->callstack["database"])) {
+               if (isset($this->callstack['database'])) {
                        $output .= "\nDatabase Read:\n";
-                       foreach ($this->callstack["database"] as $func => $time) {
+                       foreach ($this->callstack['database'] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
-                                       $output .= $func . ": " . $time . "\n";
+                               if ($time > $limit) {
+                                       $output .= $func . ': ' . $time . "\n";
                                }
                        }
                }
-               if (isset($this->callstack["database_write"])) {
+
+               if (isset($this->callstack['database_write'])) {
                        $output .= "\nDatabase Write:\n";
-                       foreach ($this->callstack["database_write"] as $func => $time) {
+                       foreach ($this->callstack['database_write'] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
-                                       $output .= $func . ": " . $time . "\n";
+                               if ($time > $limit) {
+                                       $output .= $func . ': ' . $time . "\n";
                                }
                        }
                }
-               if (isset($this->callstack["cache"])) {
+
+               if (isset($this->callstack['cache'])) {
                        $output .= "\nCache Read:\n";
-                       foreach ($this->callstack["cache"] as $func => $time) {
+                       foreach ($this->callstack['cache'] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
-                                       $output .= $func . ": " . $time . "\n";
+                               if ($time > $limit) {
+                                       $output .= $func . ': ' . $time . "\n";
                                }
                        }
                }
-               if (isset($this->callstack["cache_write"])) {
+
+               if (isset($this->callstack['cache_write'])) {
                        $output .= "\nCache Write:\n";
-                       foreach ($this->callstack["cache_write"] as $func => $time) {
+                       foreach ($this->callstack['cache_write'] as $func => $time) {
                                $time = round($time, 3);
-                               if ($time > 0) {
-                                       $output .= $func . ": " . $time . "\n";
+                               if ($time > $limit) {
+                                       $output .= $func . ': ' . $time . "\n";
                                }
                        }
                }
-               if (isset($this->callstack["network"])) {
+
+               if (isset($this->callstack['network'])) {
                        $output .= "\nNetwork:\n";
-                       foreach ($this->callstack["network"] as $func => $time) {
+                       foreach ($this->callstack['network'] as $func => $time) {
+                               $time = round($time, 3);
+                               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 > 0) {
-                                       $output .= $func . ": " . $time . "\n";
+                               if ($time > $limit) {
+                                       $output .= $func . ': ' . $time . "\n";
                                }
                        }
                }
@@ -230,24 +300,26 @@ class Profiler implements ContainerInterface
         *
         * @param LoggerInterface $logger  The logger to save the current log
         * @param string          $message Additional message for the log
+        *
+        * @return void
         */
-       public function saveLog(LoggerInterface $logger, $message = '')
+       public function saveLog(LoggerInterface $logger, string $message = '')
        {
                $duration = microtime(true) - $this->get('start');
                $logger->info(
                        $message,
                        [
-                               'action' => 'profiling',
-                               'database_read' => round($this->get('database') - $this->get('database_write'), 3),
+                               'action'         => 'profiling',
+                               'database_read'  => round($this->get('database') - $this->get('database_write'), 3),
                                'database_write' => round($this->get('database_write'), 3),
-                               'cache_read' => round($this->get('cache'), 3),
-                               'cache_write' => round($this->get('cache_write'), 3),
-                               'network_io' => round($this->get('network'), 2),
-                               'file_io' => round($this->get('file'), 2),
-                               'other_io' => round($duration - ($this->get('database')
-                                               + $this->get('cache') + $this->get('cache_write')
-                                               + $this->get('network') + $this->get('file')), 2),
-                               'total' => round($duration, 2)
+                               'cache_read'     => round($this->get('cache'), 3),
+                               'cache_write'    => round($this->get('cache_write'), 3),
+                               'network_io'     => round($this->get('network'), 2),
+                               'file_io'        => round($this->get('file'), 2),
+                               'other_io'       => round($duration - ($this->get('database')
+                                                                                                          + $this->get('cache') + $this->get('cache_write')
+                                                                                                          + $this->get('network') + $this->get('file')), 2),
+                               'total'          => round($duration, 2)
                        ]
                );
 
@@ -262,12 +334,12 @@ class Profiler implements ContainerInterface
         *
         * @param string $id Identifier of the entry to look for.
         *
-        * @throws NotFoundExceptionInterface  No entry was found for **this** identifier.
+        * @return float Entry.
         * @throws ContainerExceptionInterface Error while retrieving the entry.
         *
-        * @return int Entry.
+        * @throws NotFoundExceptionInterface  No entry was found for **this** identifier.
         */
-       public function get($id)
+       public function get(string $id): float
        {
                if (!$this->has($id)) {
                        return 0;
@@ -276,6 +348,11 @@ class Profiler implements ContainerInterface
                }
        }
 
+       public function set($timestamp, string $id)
+       {
+               $this->performance[$id] = $timestamp;
+       }
+
        /**
         * Returns true if the container can return an entry for the given identifier.
         * Returns false otherwise.
@@ -287,7 +364,7 @@ class Profiler implements ContainerInterface
         *
         * @return bool
         */
-       public function has($id)
+       public function has(string $id): bool
        {
                return isset($this->performance[$id]);
        }