1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Piotr Mrówczyński <mrow4a@yahoo.com>
* @author Robin Appelman <robin@icewind.nl>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Diagnostics;
use OC\Log;
use OC\SystemConfig;
use OCP\Diagnostics\IEvent;
use OCP\Diagnostics\IEventLogger;
use Psr\Log\LoggerInterface;
class EventLogger implements IEventLogger {
/** @var Event[] */
private $events = [];
/** @var SystemConfig */
private $config;
/** @var LoggerInterface */
private $logger;
/** @var Log */
private $internalLogger;
/**
* @var bool - Module needs to be activated by some app
*/
private $activated = false;
public function __construct(SystemConfig $config, LoggerInterface $logger, Log $internalLogger) {
$this->config = $config;
$this->logger = $logger;
$this->internalLogger = $internalLogger;
if ($this->isLoggingActivated()) {
$this->activate();
}
}
public function isLoggingActivated(): bool {
$systemValue = (bool)$this->config->getValue('diagnostics.logging', false)
|| (bool)$this->config->getValue('profiler', false);
if ($systemValue && $this->config->getValue('debug', false)) {
return true;
}
$isDebugLevel = $this->internalLogger->getLogLevel([]) === Log::DEBUG;
return $systemValue && $isDebugLevel;
}
/**
* @inheritdoc
*/
public function start($id, $description = '') {
if ($this->activated) {
$this->events[$id] = new Event($id, $description, microtime(true));
$this->writeLog($this->events[$id]);
}
}
/**
* @inheritdoc
*/
public function end($id) {
if ($this->activated && isset($this->events[$id])) {
$timing = $this->events[$id];
$timing->end(microtime(true));
$this->writeLog($timing);
}
}
/**
* @inheritdoc
*/
public function log($id, $description, $start, $end) {
if ($this->activated) {
$this->events[$id] = new Event($id, $description, $start);
$this->events[$id]->end($end);
$this->writeLog($this->events[$id]);
}
}
/**
* @inheritdoc
*/
public function getEvents() {
return $this->events;
}
/**
* @inheritdoc
*/
public function activate() {
$this->activated = true;
}
private function writeLog(IEvent $event) {
if ($this->activated) {
if ($event->getEnd() === null) {
return;
}
$duration = $event->getDuration();
$timeInMs = round($duration * 1000, 4);
$loggingMinimum = (int)$this->config->getValue('diagnostics.logging.threshold', 0);
if ($loggingMinimum > 0 && $timeInMs < $loggingMinimum) {
return;
}
$message = microtime() . ' - ' . $event->getId() . ': ' . $timeInMs . ' (' . $event->getDescription() . ')';
$this->logger->debug($message, ['app' => 'diagnostics']);
}
}
}
|