enable Sentry breadcrumbs via Elastica logging

Author: limenet

composer.json

@@ -32,7 +32,10 @@
         "phpstan/phpstan-phpunit": "^1.3.13",
         "phpstan/phpstan-strict-rules": "^1.5.1",
         "phpunit/phpunit": "^10.2.5",
-        "rector/rector": "^0.17.5"
+        "psr/log": "^3.0",
+        "rector/rector": "^0.17.5",
+        "sentry/sentry": "^3.20.1",
+        "symfony/http-client": "^6.3.1"
     },
     "autoload": {
         "psr-4": {
@@ -62,7 +65,8 @@
         "sort-packages": true,
         "allow-plugins": {
             "pestphp/pest-plugin": true,
-            "phpstan/extension-installer": true
+            "phpstan/extension-installer": true,
+            "php-http/discovery": true
         }
     },
     "extra": {

config/elastica-bridge.php

@@ -10,4 +10,7 @@
     'events' => [
         'listen' => true,
     ],
+    'logging' => [
+        'sentry_breadcrumbs' => false,
+    ],
 ];

src/Client/ElasticaClient.php

@@ -6,6 +6,7 @@
 
 use Elastica\Client;
 use Elastica\Index;
+use Limenet\LaravelElasticaBridge\Logging\SentryBreadcrumbLogger;
 
 class ElasticaClient
 {
@@ -15,10 +16,16 @@ class ElasticaClient
 
     public function __construct()
     {
-        $this->client = new Client([
+        $client = new Client([
             'host' => config('elastica-bridge.elasticsearch.host'),
             'port' => config('elastica-bridge.elasticsearch.port'),
         ]);
+
+        if (config('elastica-bridge.logging.sentry_breadcrumbs') === true && class_exists('\Sentry\Breadcrumb')) {
+            $client->setLogger(new SentryBreadcrumbLogger());
+        }
+
+        $this->client = $client;
     }
 
     public function getClient(): Client

src/Logging/SentryBreadcrumbLogger.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Limenet\LaravelElasticaBridge\Logging;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerTrait;
+use Psr\Log\LogLevel;
+use Sentry\Breadcrumb;
+use Stringable;
+
+class SentryBreadcrumbLogger implements LoggerInterface
+{
+    use LoggerTrait;
+
+    /**
+     * @param  LogLevel::*|mixed  $level
+     */
+    public function log($level, string|Stringable $message, array $context = []): void
+    {
+        if ($message instanceof Stringable) {
+            $message = $message->__toString();
+        }
+
+        \Sentry\addBreadcrumb(
+            new Breadcrumb(
+                match ($level) {
+                    LogLevel::EMERGENCY, LogLevel::CRITICAL => Breadcrumb::LEVEL_FATAL,
+                    LogLevel::ALERT,  LogLevel::ERROR => Breadcrumb::LEVEL_ERROR,
+                    LogLevel::WARNING => Breadcrumb::LEVEL_WARNING,
+                    LogLevel::INFO, LogLevel::NOTICE => Breadcrumb::LEVEL_INFO,
+                    LogLevel::DEBUG => Breadcrumb::LEVEL_DEBUG,
+                    default => Breadcrumb::LEVEL_DEBUG,
+                },
+                match ($level) {
+                    Breadcrumb::LEVEL_FATAL, Breadcrumb::LEVEL_ERROR => Breadcrumb::TYPE_ERROR,
+                    default => Breadcrumb::TYPE_DEFAULT,
+                },
+                'elastica',
+                $message,
+                $context
+            )
+        );
+    }
+}

tests/Unit/ClientTest.php

@@ -4,7 +4,10 @@
 
 namespace Limenet\LaravelElasticaBridge\Tests\Unit;
 
+use Elastica\Client;
 use Limenet\LaravelElasticaBridge\Client\ElasticaClient;
+use Limenet\LaravelElasticaBridge\Logging\SentryBreadcrumbLogger;
+use Psr\Log\LoggerInterface;
 
 class ClientTest extends TestCase
 {
@@ -23,5 +26,30 @@ public function test_configured_client(): void
 
         $this->assertSame('localhost', $client->getConfig('host'));
         $this->assertEquals(9200, $client->getConfig('port'));
+
+    }
+
+    public function test_sentry_logger_not_active_by_default(): void
+    {
+        $client = $this->elasticaClient->getClient();
+
+        $this->assertNotInstanceOf(SentryBreadcrumbLogger::class, $this->getLoggerProperty($client));
+    }
+
+    public function test_sentry_logger_enabled(): void
+    {
+        config()->set('elastica-bridge.logging.sentry_breadcrumbs', true);
+        $client = (new ElasticaClient)->getClient();
+
+        $this->assertInstanceOf(SentryBreadcrumbLogger::class, $this->getLoggerProperty($client));
+    }
+
+    private function getLoggerProperty(Client $client): LoggerInterface
+    {
+        $reflectedClass = new \ReflectionClass($client);
+        $reflection = $reflectedClass->getProperty('_logger');
+        $reflection->setAccessible(true);
+
+        return $reflection->getValue($client);
     }
 }