summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lib/private/Log.php4
-rw-r--r--lib/private/Support/CrashReport/Registry.php18
-rw-r--r--lib/public/Support/CrashReport/ICollectBreadcrumbs.php43
-rw-r--r--lib/public/Support/CrashReport/IRegistry.php11
-rw-r--r--tests/lib/Support/CrashReport/RegistryTest.php15
5 files changed, 91 insertions, 0 deletions
diff --git a/lib/private/Log.php b/lib/private/Log.php
index 33d1ddcdc34..43ff4cc9dee 100644
--- a/lib/private/Log.php
+++ b/lib/private/Log.php
@@ -217,6 +217,10 @@ class Log implements ILogger {
if ($level >= $minLevel) {
$this->writeLog($app, $message, $level);
}
+
+ if (!is_null($this->crashReporters)) {
+ $this->crashReporters->delegateBreadcrumb($message, 'log', $context);
+ }
}
private function getLogLevel($context) {
diff --git a/lib/private/Support/CrashReport/Registry.php b/lib/private/Support/CrashReport/Registry.php
index 5eb78965c19..d07509561c6 100644
--- a/lib/private/Support/CrashReport/Registry.php
+++ b/lib/private/Support/CrashReport/Registry.php
@@ -23,6 +23,7 @@
namespace OC\Support\CrashReport;
use Exception;
+use OCP\Support\CrashReport\ICollectBreadcrumbs;
use OCP\Support\CrashReport\IRegistry;
use OCP\Support\CrashReport\IReporter;
use Throwable;
@@ -42,6 +43,23 @@ class Registry implements IRegistry {
}
/**
+ * Delegate breadcrumb collection to all registered reporters
+ *
+ * @param string $message
+ * @param string $category
+ * @param array $context
+ *
+ * @since 13.0.0
+ */
+ public function delegateBreadcrumb(string $message, string $category, array $context = []) {
+ foreach ($this->reporters as $reporter) {
+ if ($reporter instanceof ICollectBreadcrumbs) {
+ $reporter->collect($message, $category, $context);
+ }
+ }
+ }
+
+ /**
* Delegate crash reporting to all registered reporters
*
* @param Exception|Throwable $exception
diff --git a/lib/public/Support/CrashReport/ICollectBreadcrumbs.php b/lib/public/Support/CrashReport/ICollectBreadcrumbs.php
new file mode 100644
index 00000000000..6f331077f1a
--- /dev/null
+++ b/lib/public/Support/CrashReport/ICollectBreadcrumbs.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Support\CrashReport;
+
+/**
+ * @since 15.0.0
+ */
+interface ICollectBreadcrumbs extends IReporter {
+
+ /**
+ * Collect breadcrumbs for crash reports
+ *
+ * @param string $message
+ * @param string $category
+ * @param array $context
+ *
+ * @since 15.0.0
+ */
+ public function collect(string $message, string $category, array $context = []);
+
+}
diff --git a/lib/public/Support/CrashReport/IRegistry.php b/lib/public/Support/CrashReport/IRegistry.php
index 62432c782ab..fe6f6beb7bb 100644
--- a/lib/public/Support/CrashReport/IRegistry.php
+++ b/lib/public/Support/CrashReport/IRegistry.php
@@ -39,6 +39,17 @@ interface IRegistry {
public function register(IReporter $reporter);
/**
+ * Delegate breadcrumb collection to all registered reporters
+ *
+ * @param string $message
+ * @param string $category
+ * @param array $context
+ *
+ * @since 13.0.0
+ */
+ public function delegateBreadcrumb(string $message, string $category, array $context = []);
+
+ /**
* Delegate crash reporting to all registered reporters
*
* @since 13.0.0
diff --git a/tests/lib/Support/CrashReport/RegistryTest.php b/tests/lib/Support/CrashReport/RegistryTest.php
index ba225ec1330..5cb15db7345 100644
--- a/tests/lib/Support/CrashReport/RegistryTest.php
+++ b/tests/lib/Support/CrashReport/RegistryTest.php
@@ -26,6 +26,7 @@ namespace Test\Support\CrashReport;
use Exception;
use OC\Support\CrashReport\Registry;
+use OCP\Support\CrashReport\ICollectBreadcrumbs;
use OCP\Support\CrashReport\IReporter;
use Test\TestCase;
@@ -50,6 +51,20 @@ class RegistryTest extends TestCase {
$this->addToAssertionCount(1);
}
+ public function testDelegateBreadcrumbCollection() {
+ $reporter1 = $this->createMock(IReporter::class);
+ $reporter2 = $this->createMock(ICollectBreadcrumbs::class);
+ $message = 'hello';
+ $category = 'log';
+ $reporter2->expects($this->once())
+ ->method('collect')
+ ->with($message, $category);
+
+ $this->registry->register($reporter1);
+ $this->registry->register($reporter2);
+ $this->registry->delegateBreadcrumb($message, $category);
+ }
+
public function testDelegateToAll() {
$reporter1 = $this->createMock(IReporter::class);
$reporter2 = $this->createMock(IReporter::class);