src/Util/Profiler.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Util;
  23
  24 use Friendica\Core\Config\Cache;
  25 use Friendica\Core\Config\IConfig;
  26 use Friendica\Core\System;
  27 use Psr\Container\ContainerExceptionInterface;
  28 use Psr\Container\ContainerInterface;
  29 use Psr\Container\NotFoundExceptionInterface;
  30 use Psr\Log\LoggerInterface;
  31
  32 /**
  33  * A class to store profiling data
  34  * It can handle different logging data for specific functions or global performance measures
  35  *
  36  * It stores the data as log entries (@see LoggerInterface)
  37  */
  38 class Profiler implements ContainerInterface
  39 {
  40         /**
  41          * @var array The global performance array
  42          */
  43         private $performance;
  44         /**
  45          * @var array The function specific callstack
  46          */
  47         private $callstack;
  48         /**
  49          * @var bool True, if the Profiler is enabled
  50          */
  51         private $enabled;
  52         /**
  53          * @var bool True, if the Profiler should measure the whole rendertime including functions
  54          */
  55         private $rendertime;
  56
  57         /**
  58          * True, if the Profiler should measure the whole rendertime including functions
  59          *
  60          * @return bool
  61          */
  62         public function isRendertime()
  63         {
  64                 return $this->rendertime;
  65         }
  66
  67         /**
  68          * Updates the enabling of the current profiler
  69          *
  70          * @param IConfig $config
  71          */
  72         public function update(IConfig $config)
  73         {
  74                 $this->enabled = $config->get('system', 'profiler');
  75                 $this->rendertime = $config->get('rendertime', 'callstack');
  76         }
  77
  78         /**
  79          * @param Cache $configCache The configuration cache
  80          */
  81         public function __construct(Cache $configCache)
  82         {
  83                 $this->enabled = $configCache->get('system', 'profiler');
  84                 $this->rendertime = $configCache->get('rendertime', 'callstack');
  85                 $this->reset();
  86         }
  87
  88         /**
  89          * Saves a timestamp for a value - f.e. a call
  90          * Necessary for profiling Friendica
  91          *
  92          * @param int    $timestamp the Timestamp
  93          * @param string $value     A value to profile
  94          * @param string $callstack A callstack string, generated if absent
  95          */
  96         public function saveTimestamp($timestamp, $value, $callstack = '')
  97         {
  98                 if (!$this->enabled) {
  99                         return;
 100                 }
 101
 102                 $callstack = $callstack ?: System::callstack(4, 1);
 103
 104                 $duration = floatval(microtime(true) - $timestamp);
 105
 106                 if (!isset($this->performance[$value])) {
 107                         // Prevent ugly E_NOTICE
 108                         $this->performance[$value] = 0;
 109                 }
 110
 111                 $this->performance[$value] += (float) $duration;
 112                 $this->performance['marktime'] += (float) $duration;
 113
 114                 if (!isset($this->callstack[$value][$callstack])) {
 115                         // Prevent ugly E_NOTICE
 116                         $this->callstack[$value][$callstack] = 0;
 117                 }
 118
 119                 $this->callstack[$value][$callstack] += (float) $duration;
 120         }
 121
 122         /**
 123          * Resets the performance and callstack profiling
 124          */
 125         public function reset()
 126         {
 127                 $this->resetPerformance();
 128                 $this->resetCallstack();
 129         }
 130
 131         /**
 132          * Resets the performance profiling data
 133          */
 134         public function resetPerformance()
 135         {
 136                 $this->performance = [];
 137                 $this->performance['start'] = microtime(true);
 138                 $this->performance['database'] = 0;
 139                 $this->performance['database_write'] = 0;
 140                 $this->performance['cache'] = 0;
 141                 $this->performance['cache_write'] = 0;
 142                 $this->performance['network'] = 0;
 143                 $this->performance['file'] = 0;
 144                 $this->performance['rendering'] = 0;
 145                 $this->performance['parser'] = 0;
 146                 $this->performance['marktime'] = 0;
 147                 $this->performance['marktime'] = microtime(true);
 148         }
 149
 150         /**
 151          * Resets the callstack profiling data
 152          */
 153         public function resetCallstack()
 154         {
 155                 $this->callstack = [];
 156                 $this->callstack['database'] = [];
 157                 $this->callstack['database_write'] = [];
 158                 $this->callstack['cache'] = [];
 159                 $this->callstack['cache_write'] = [];
 160                 $this->callstack['network'] = [];
 161                 $this->callstack['file'] = [];
 162                 $this->callstack['rendering'] = [];
 163                 $this->callstack['parser'] = [];
 164         }
 165
 166         /**
 167          * Returns the rendertime string
 168          * @param float $limit Minimal limit for displaying the execution duration
 169          *
 170          * @return string the rendertime
 171          */
 172         public function getRendertimeString(float $limit = 0)
 173         {
 174                 $output = '';
 175
 176                 if (!$this->enabled || !$this->rendertime) {
 177                         return $output;
 178                 }
 179
 180                 if (isset($this->callstack["database"])) {
 181                         $output .= "\nDatabase Read:\n";
 182                         foreach ($this->callstack["database"] as $func => $time) {
 183                                 $time = round($time, 3);
 184                                 if ($time > $limit) {
 185                                         $output .= $func . ": " . $time . "\n";
 186                                 }
 187                         }
 188                 }
 189                 if (isset($this->callstack["database_write"])) {
 190                         $output .= "\nDatabase Write:\n";
 191                         foreach ($this->callstack["database_write"] as $func => $time) {
 192                                 $time = round($time, 3);
 193                                 if ($time > $limit) {
 194                                         $output .= $func . ": " . $time . "\n";
 195                                 }
 196                         }
 197                 }
 198                 if (isset($this->callstack["cache"])) {
 199                         $output .= "\nCache Read:\n";
 200                         foreach ($this->callstack["cache"] as $func => $time) {
 201                                 $time = round($time, 3);
 202                                 if ($time > $limit) {
 203                                         $output .= $func . ": " . $time . "\n";
 204                                 }
 205                         }
 206                 }
 207                 if (isset($this->callstack["cache_write"])) {
 208                         $output .= "\nCache Write:\n";
 209                         foreach ($this->callstack["cache_write"] as $func => $time) {
 210                                 $time = round($time, 3);
 211                                 if ($time > $limit) {
 212                                         $output .= $func . ": " . $time . "\n";
 213                                 }
 214                         }
 215                 }
 216                 if (isset($this->callstack["network"])) {
 217                         $output .= "\nNetwork:\n";
 218                         foreach ($this->callstack["network"] as $func => $time) {
 219                                 $time = round($time, 3);
 220                                 if ($time > $limit) {
 221                                         $output .= $func . ": " . $time . "\n";
 222                                 }
 223                         }
 224                 }
 225
 226                 return $output;
 227         }
 228
 229         /**
 230          * Save the current profiling data to a log entry
 231          *
 232          * @param LoggerInterface $logger  The logger to save the current log
 233          * @param string          $message Additional message for the log
 234          */
 235         public function saveLog(LoggerInterface $logger, $message = '')
 236         {
 237                 $duration = microtime(true) - $this->get('start');
 238                 $logger->info(
 239                         $message,
 240                         [
 241                                 'action' => 'profiling',
 242                                 'database_read' => round($this->get('database') - $this->get('database_write'), 3),
 243                                 'database_write' => round($this->get('database_write'), 3),
 244                                 'cache_read' => round($this->get('cache'), 3),
 245                                 'cache_write' => round($this->get('cache_write'), 3),
 246                                 'network_io' => round($this->get('network'), 2),
 247                                 'file_io' => round($this->get('file'), 2),
 248                                 'other_io' => round($duration - ($this->get('database')
 249                                                 + $this->get('cache') + $this->get('cache_write')
 250                                                 + $this->get('network') + $this->get('file')), 2),
 251                                 'total' => round($duration, 2)
 252                         ]
 253                 );
 254
 255                 if ($this->isRendertime()) {
 256                         $output = $this->getRendertimeString();
 257                         $logger->info($message . ": " . $output, ['action' => 'profiling']);
 258                 }
 259         }
 260
 261         /**
 262          * Finds an entry of the container by its identifier and returns it.
 263          *
 264          * @param string $id Identifier of the entry to look for.
 265          *
 266          * @throws NotFoundExceptionInterface  No entry was found for **this** identifier.
 267          * @throws ContainerExceptionInterface Error while retrieving the entry.
 268          *
 269          * @return int Entry.
 270          */
 271         public function get($id)
 272         {
 273                 if (!$this->has($id)) {
 274                         return 0;
 275                 } else {
 276                         return $this->performance[$id];
 277                 }
 278         }
 279
 280         /**
 281          * Returns true if the container can return an entry for the given identifier.
 282          * Returns false otherwise.
 283          *
 284          * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
 285          * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`.
 286          *
 287          * @param string $id Identifier of the entry to look for.
 288          *
 289          * @return bool
 290          */
 291         public function has($id)
 292         {
 293                 return isset($this->performance[$id]);
 294         }
 295 }