3 namespace Friendica\Util;
5 use Psr\Container\ContainerExceptionInterface;
6 use Psr\Container\ContainerInterface;
7 use Psr\Container\NotFoundExceptionInterface;
8 use Psr\Log\LoggerInterface;
11 * A class to store profiling data
12 * It can handle different logging data for specific functions or global performance measures
14 * It stores the data as log entries (@see LoggerInterface )
16 class Profiler implements ContainerInterface
19 * @var array The global performance array
23 * @var array The function specific callstack
27 * @var bool True, if the Profiler is enabled
31 * @var bool True, if the Profiler should measure the whole rendertime including functions
36 * @var LoggerInterface The profiler logger
41 * @param LoggerInterface $logger The profiler logger
42 * @param bool $enabled True, if the Profiler is enabled
43 * @param bool $renderTime True, if the Profiler should measure the whole rendertime including functions
45 public function __construct(LoggerInterface $logger, $enabled = false, $renderTime = false)
47 $this->enabled = $enabled;
48 $this->rendertime = $renderTime;
49 $this->logger = $logger;
54 * Saves a timestamp for a value - f.e. a call
55 * Necessary for profiling Friendica
57 * @param int $timestamp the Timestamp
58 * @param string $value A value to profile
59 * @param string $callstack The callstack of the current profiling data
61 public function saveTimestamp($timestamp, $value, $callstack = '')
63 if (!$this->enabled) {
67 $duration = (float) (microtime(true) - $timestamp);
69 if (!isset($this->performance[$value])) {
70 // Prevent ugly E_NOTICE
71 $this->performance[$value] = 0;
74 $this->performance[$value] += (float) $duration;
75 $this->performance['marktime'] += (float) $duration;
77 if (!isset($this->callstack[$value][$callstack])) {
78 // Prevent ugly E_NOTICE
79 $this->callstack[$value][$callstack] = 0;
82 $this->callstack[$value][$callstack] += (float) $duration;
86 * Resets the performance and callstack profiling
88 * @param bool $performance If true, reset the performance (Default true)
89 * @param bool $callstack If true, reset the callstack (Default true)
91 public function reset($performance = true, $callstack = true)
94 $this->performance = [];
95 $this->performance['start'] = microtime(true);
96 $this->performance['database'] = 0;
97 $this->performance['database_write'] = 0;
98 $this->performance['cache'] = 0;
99 $this->performance['cache_write'] = 0;
100 $this->performance['network'] = 0;
101 $this->performance['file'] = 0;
102 $this->performance['rendering'] = 0;
103 $this->performance['parser'] = 0;
104 $this->performance['marktime'] = 0;
105 $this->performance['marktime'] = microtime(true);
109 $this->callstack['database'] = [];
110 $this->callstack['database_write'] = [];
111 $this->callstack['cache'] = [];
112 $this->callstack['cache_write'] = [];
113 $this->callstack['network'] = [];
114 $this->callstack['file'] = [];
115 $this->callstack['rendering'] = [];
116 $this->callstack['parser'] = [];
121 * Save the current profiling data to a log entry
123 * @param string $message Additional message for the log
125 public function saveLog($message = '')
127 // Write down the performance values into the log
128 if ($this->enabled) {
129 $duration = microtime(true)-$this->get('start');
135 'database_read' => round($this->get('database') - $this->get('database_write'), 3),
136 'database_write' => round($this->get('database_write'), 3),
137 'cache_read' => round($this->get('cache'), 3),
138 'cache_write' => round($this->get('cache_write'), 3),
139 'network_io' => round($this->get('network'), 2),
140 'file_io' => round($this->get('file'), 2),
141 'other_io' => round($duration - ($this->get('database')
142 + $this->get('cache') + $this->get('cache_write')
143 + $this->get('network') + $this->get('file')), 2),
144 'total' => round($duration, 2)
149 if ($this->rendertime) {
150 if (isset($this->callstack["database"])) {
151 $o .= "\nDatabase Read:\n";
152 foreach ($this->callstack["database"] as $func => $time) {
153 $time = round($time, 3);
155 $o .= $func.": ".$time."\n";
159 if (isset($this->callstack["database_write"])) {
160 $o .= "\nDatabase Write:\n";
161 foreach ($this->callstack["database_write"] as $func => $time) {
162 $time = round($time, 3);
164 $o .= $func.": ".$time."\n";
168 if (isset($this->callstack["cache"])) {
169 $o .= "\nCache Read:\n";
170 foreach ($this->callstack["cache"] as $func => $time) {
171 $time = round($time, 3);
173 $o .= $func.": ".$time."\n";
177 if (isset($this->callstack["cache_write"])) {
178 $o .= "\nCache Write:\n";
179 foreach ($this->callstack["cache_write"] as $func => $time) {
180 $time = round($time, 3);
182 $o .= $func.": ".$time."\n";
186 if (isset($this->callstack["network"])) {
187 $o .= "\nNetwork:\n";
188 foreach ($this->callstack["network"] as $func => $time) {
189 $time = round($time, 3);
191 $o .= $func.": ".$time."\n";
195 $this->logger->info($message . ": " . $o);
202 * Finds an entry of the container by its identifier and returns it.
204 * @param string $id Identifier of the entry to look for.
206 * @throws NotFoundExceptionInterface No entry was found for **this** identifier.
207 * @throws ContainerExceptionInterface Error while retrieving the entry.
211 public function get($id)
213 if (!$this->has($id)) {
216 return $this->performance[$id];
221 * Returns true if the container can return an entry for the given identifier.
222 * Returns false otherwise.
224 * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
225 * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`.
227 * @param string $id Identifier of the entry to look for.
231 public function has($id)
233 return isset($this->performance[$id]);