aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Diagnostics/EventLogger.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Diagnostics/EventLogger.php')
-rw-r--r--lib/private/Diagnostics/EventLogger.php119
1 files changed, 119 insertions, 0 deletions
diff --git a/lib/private/Diagnostics/EventLogger.php b/lib/private/Diagnostics/EventLogger.php
new file mode 100644
index 00000000000..3ec35a5e9ce
--- /dev/null
+++ b/lib/private/Diagnostics/EventLogger.php
@@ -0,0 +1,119 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+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']);
+ }
+ }
+}