aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Diagnostics
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Diagnostics')
-rw-r--r--lib/private/Diagnostics/Event.php28
-rw-r--r--lib/private/Diagnostics/EventLogger.php92
-rw-r--r--lib/private/Diagnostics/Query.php27
-rw-r--r--lib/private/Diagnostics/QueryLogger.php46
4 files changed, 89 insertions, 104 deletions
diff --git a/lib/private/Diagnostics/Event.php b/lib/private/Diagnostics/Event.php
index 97da22b12a3..11d6505a888 100644
--- a/lib/private/Diagnostics/Event.php
+++ b/lib/private/Diagnostics/Event.php
@@ -1,26 +1,10 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Morris Jobke <hey@morrisjobke.de>
- * @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/>
- *
+ * 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;
@@ -101,4 +85,8 @@ class Event implements IEvent {
}
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
index 115a8ebba92..3ec35a5e9ce 100644
--- a/lib/private/Diagnostics/EventLogger.php
+++ b/lib/private/Diagnostics/EventLogger.php
@@ -1,49 +1,65 @@
<?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/>
- *
+ * 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 \OC\Diagnostics\Event[]
- */
+ /** @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) {
+ public function start($id, $description = '') {
if ($this->activated) {
$this->events[$id] = new Event($id, $description, microtime(true));
+ $this->writeLog($this->events[$id]);
}
}
@@ -54,6 +70,7 @@ class EventLogger implements IEventLogger {
if ($this->activated && isset($this->events[$id])) {
$timing = $this->events[$id];
$timing->end(microtime(true));
+ $this->writeLog($timing);
}
}
@@ -64,6 +81,7 @@ class EventLogger implements IEventLogger {
if ($this->activated) {
$this->events[$id] = new Event($id, $description, $start);
$this->events[$id]->end($end);
+ $this->writeLog($this->events[$id]);
}
}
@@ -73,11 +91,29 @@ class EventLogger implements IEventLogger {
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
index a5fb32e0d90..020fc4bb512 100644
--- a/lib/private/Diagnostics/Query.php
+++ b/lib/private/Diagnostics/Query.php
@@ -1,27 +1,10 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @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/>
- *
+ * 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;
@@ -73,7 +56,7 @@ class Query implements IQuery {
public function getStart() {
return $this->start;
}
-
+
/**
* @return float
*/
diff --git a/lib/private/Diagnostics/QueryLogger.php b/lib/private/Diagnostics/QueryLogger.php
index 6093603a576..5efe99d1a74 100644
--- a/lib/private/Diagnostics/QueryLogger.php
+++ b/lib/private/Diagnostics/QueryLogger.php
@@ -1,43 +1,20 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @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/>
- *
+ * 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\Cache\CappedMemoryCache;
+use OCP\Cache\CappedMemoryCache;
use OCP\Diagnostics\IQueryLogger;
class QueryLogger implements IQueryLogger {
- /**
- * @var \OC\Diagnostics\Query
- */
- protected $activeQuery;
-
- /**
- * @var CappedMemoryCache
- */
- protected $queries;
+ protected int $index = 0;
+ protected ?Query $activeQuery = null;
+ /** @var CappedMemoryCache<Query> */
+ protected CappedMemoryCache $queries;
/**
* QueryLogger constructor.
@@ -55,7 +32,7 @@ class QueryLogger implements IQueryLogger {
/**
* @inheritdoc
*/
- public function startQuery($sql, array $params = null, array $types = null) {
+ public function startQuery($sql, ?array $params = null, ?array $types = null) {
if ($this->activated) {
$this->activeQuery = new Query($sql, $params, microtime(true), $this->getStack());
}
@@ -75,7 +52,8 @@ class QueryLogger implements IQueryLogger {
public function stopQuery() {
if ($this->activated && $this->activeQuery) {
$this->activeQuery->end(microtime(true));
- $this->queries[] = $this->activeQuery;
+ $this->queries[(string)$this->index] = $this->activeQuery;
+ $this->index++;
$this->activeQuery = null;
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 22:11:53 +0000