4 files changed, 359 insertions, 0 deletions
diff --git a/lib/private/Diagnostics/Event.php b/lib/private/Diagnostics/Event.php
new file mode 100644
index 00000000000..11d6505a888
--- /dev/null
+++ b/lib/private/Diagnostics/Event.php
@@ -0,0 +1,92 @@
+<?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 OCP\Diagnostics\IEvent;
+
+class Event implements IEvent {
+	/**
+	 * @var string
+	 */
+	protected $id;
+
+	/**
+	 * @var float
+	 */
+	protected $start;
+
+	/**
+	 * @var float
+	 */
+	protected $end;
+
+	/**
+	 * @var string
+	 */
+	protected $description;
+
+	/**
+	 * @param string $id
+	 * @param string $description
+	 * @param float $start
+	 */
+	public function __construct($id, $description, $start) {
+		$this->id = $id;
+		$this->description = $description;
+		$this->start = $start;
+	}
+
+	/**
+	 * @param float $time
+	 */
+	public function end($time) {
+		$this->end = $time;
+	}
+
+	/**
+	 * @return float
+	 */
+	public function getStart() {
+		return $this->start;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getId() {
+		return $this->id;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDescription() {
+		return $this->description;
+	}
+
+	/**
+	 * @return float
+	 */
+	public function getEnd() {
+		return $this->end;
+	}
+
+	/**
+	 * @return float
+	 */
+	public function getDuration() {
+		if (!$this->end) {
+			$this->end = microtime(true);
+		}
+		return $this->end - $this->start;
+	}
+
+	public function __toString(): string {
+		return $this->getId() . ' ' . $this->getDescription() . ' ' . $this->getDuration();
+	}
+}
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']);
+		}
+	}
+}
diff --git a/lib/private/Diagnostics/Query.php b/lib/private/Diagnostics/Query.php
new file mode 100644
index 00000000000..020fc4bb512
--- /dev/null
+++ b/lib/private/Diagnostics/Query.php
@@ -0,0 +1,74 @@
+<?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 OCP\Diagnostics\IQuery;
+
+class Query implements IQuery {
+	private $sql;
+
+	private $params;
+
+	private $start;
+
+	private $end;
+
+	private $stack;
+
+	/**
+	 * @param string $sql
+	 * @param array $params
+	 * @param int $start
+	 */
+	public function __construct($sql, $params, $start, array $stack) {
+		$this->sql = $sql;
+		$this->params = $params;
+		$this->start = $start;
+		$this->stack = $stack;
+	}
+
+	public function end($time) {
+		$this->end = $time;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getParams() {
+		return $this->params;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSql() {
+		return $this->sql;
+	}
+
+	/**
+	 * @return float
+	 */
+	public function getStart() {
+		return $this->start;
+	}
+
+	/**
+	 * @return float
+	 */
+	public function getDuration() {
+		return $this->end - $this->start;
+	}
+
+	public function getStartTime() {
+		return $this->start;
+	}
+
+	public function getStacktrace() {
+		return $this->stack;
+	}
+}
diff --git a/lib/private/Diagnostics/QueryLogger.php b/lib/private/Diagnostics/QueryLogger.php
new file mode 100644
index 00000000000..5efe99d1a74
--- /dev/null
+++ b/lib/private/Diagnostics/QueryLogger.php
@@ -0,0 +1,74 @@
+<?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 OCP\Cache\CappedMemoryCache;
+use OCP\Diagnostics\IQueryLogger;
+
+class QueryLogger implements IQueryLogger {
+	protected int $index = 0;
+	protected ?Query $activeQuery = null;
+	/** @var CappedMemoryCache<Query> */
+	protected CappedMemoryCache $queries;
+
+	/**
+	 * QueryLogger constructor.
+	 */
+	public function __construct() {
+		$this->queries = new CappedMemoryCache(1024);
+	}
+
+
+	/**
+	 * @var bool - Module needs to be activated by some app
+	 */
+	private $activated = false;
+
+	/**
+	 * @inheritdoc
+	 */
+	public function startQuery($sql, ?array $params = null, ?array $types = null) {
+		if ($this->activated) {
+			$this->activeQuery = new Query($sql, $params, microtime(true), $this->getStack());
+		}
+	}
+
+	private function getStack() {
+		$stack = debug_backtrace();
+		array_shift($stack);
+		array_shift($stack);
+		array_shift($stack);
+		return $stack;
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function stopQuery() {
+		if ($this->activated && $this->activeQuery) {
+			$this->activeQuery->end(microtime(true));
+			$this->queries[(string)$this->index] = $this->activeQuery;
+			$this->index++;
+			$this->activeQuery = null;
+		}
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function getQueries() {
+		return $this->queries->getData();
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function activate() {
+		$this->activated = true;
+	}
+}