<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\Util;
-use Friendica\Core\Config\Cache;
-use Friendica\Core\Config\IConfig;
+use Friendica\Core\Config\ValueObject\Cache;
+use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\System;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\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;
}
/**
* Updates the enabling of the current profiler
*
- * @param IConfig $config
+ * Note: The reason there are two different ways of updating the configuration of this class is because it can
+ * be used even with no available database connection which IManageConfigValues doesn't ensure.
+ *
+ * @param IManageConfigValues $config
*/
- public function update(IConfig $config)
+ public function update(IManageConfigValues $config)
{
- $this->enabled = $config->get('system', 'profiler');
- $this->rendertime = $config->get('rendertime', 'callstack');
+ $this->enabled = (bool) $config->get('system', 'profiler') ?? false;
+ $this->rendertime = (bool) $config->get('rendertime', 'callstack') ?? false;
}
/**
- * @param Cache $configCache The configuration cache
+ * Note: The reason we are using a Config Cache object to initialize this class is to ensure it'll work even with no
+ * available database connection.
+ *
+ * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache
*/
public function __construct(Cache $configCache)
{
- $this->enabled = $configCache->get('system', 'profiler');
- $this->rendertime = $configCache->get('rendertime', 'callstack');
+ $this->enabled = (bool) $configCache->get('system', 'profiler') ?? false;
+ $this->rendertime = (bool) $configCache->get('rendertime', 'callstack') ?? false;
$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 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;
/**
* Resets the performance and callstack profiling
+ *
+ * @return void
*/
public function reset()
{
/**
* Resets the performance profiling data
+ *
+ * @return void
*/
public function resetPerformance()
{
$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;
/**
* Resets the callstack profiling data
+ *
+ * @return void
*/
public function resetCallstack()
{
$this->callstack['network'] = [];
$this->callstack['file'] = [];
$this->callstack['rendering'] = [];
- $this->callstack['parser'] = [];
+ $this->callstack['session'] = [];
}
/**
*
* @return string the rendertime
*/
- public function getRendertimeString(float $limit = 0)
+ public function getRendertimeString(float $limit = 0): string
{
$output = '';
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 > $limit) {
- $output .= $func . ": " . $time . "\n";
+ $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 > $limit) {
- $output .= $func . ": " . $time . "\n";
+ $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 > $limit) {
- $output .= $func . ": " . $time . "\n";
+ $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 > $limit) {
- $output .= $func . ": " . $time . "\n";
+ $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";
+ $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";
}
}
}
*
* @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(
* @throws NotFoundExceptionInterface No entry was found for **this** identifier.
* @throws ContainerExceptionInterface Error while retrieving the entry.
*
- * @return int Entry.
+ * @return float Entry.
*/
- public function get($id)
+ public function get(string $id): float
{
if (!$this->has($id)) {
return 0;
}
}
- public function set($timestamp, $id)
+ public function set($timestamp, string $id)
{
$this->performance[$id] = $timestamp;
}
*
* @return bool
*/
- public function has($id)
+ public function has(string $id): bool
{
return isset($this->performance[$id]);
}
projects / friendica.git / blobdiff