feat(logs): introduce logging for symfony (#940)

Co-authored-by: Michi Hoffmann <[email protected]>

Author: Litarnus

src/EventListener/ConsoleListener.php

@@ -7,6 +7,7 @@
 use Sentry\Event;
 use Sentry\EventHint;
 use Sentry\ExceptionMechanism;
+use Sentry\Logs\Logs;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -71,6 +72,7 @@ public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
      */
     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
     {
+        Logs::getInstance()->flush();
         $this->hub->popScope();
     }
 

src/EventListener/LogRequestListener.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\EventListener;
+
+use Sentry\Logs\Logs;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+
+/**
+ * RequestListener for sentry log related events.
+ */
+class LogRequestListener
+{
+    /**
+     * Flushes the logs on kernel termination.
+     *
+     * @param TerminateEvent $event
+     *
+     * @return void
+     */
+    public function handleKernelTerminateEvent(TerminateEvent $event)
+    {
+        Logs::getInstance()->flush();
+    }
+}

src/Monolog/LogsHandler.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Monolog;
+
+use Monolog\Logger as MonologLogger;
+use Monolog\LogRecord;
+use Sentry\Monolog\CompatibilityLogLevelTrait;
+use Sentry\Monolog\LogsHandler as BaseLogsHandler;
+
+/**
+ * Extends the base LogsHandler so that it can be used with Monolog constants.
+ * Sentry LogLevel objects are not easily usable with symfony config files, so this provides
+ * a convenient way to instantiate the service in yaml/xml.
+ */
+class LogsHandler extends BaseLogsHandler
+{
+    use CompatibilityLogLevelTrait;
+
+    public function __construct(int $level = MonologLogger::DEBUG, bool $bubble = true)
+    {
+        $logLevel = self::getSentryLogLevelFromMonologLevel($level);
+        parent::__construct($logLevel, $bubble);
+    }
+
+    /**
+     * @param array<string, mixed>|LogRecord $record
+     */
+    public function handle($record): bool
+    {
+        // Extra check required here because `isHandling` is not guaranteed to
+        // be called, and we might accidentally capture log messages that should be filtered.
+        if ($this->isHandling($record)) {
+            return parent::handle($record);
+        }
+
+        return false;
+    }
+}

src/Resources/config/services.xml

@@ -85,6 +85,10 @@
             <tag name="kernel.event_listener" event="kernel.request" method="handleKernelRequestEvent" />
         </service>
 
+        <service id="Sentry\SentryBundle\EventListener\LogRequestListener" class="Sentry\SentryBundle\EventListener\LogRequestListener">
+            <tag name="kernel.event_listener" event="kernel.terminate" method="handleKernelTerminateEvent" priority="10" />
+        </service>
+
         <service id="Sentry\SentryBundle\Command\SentryTestCommand" class="Sentry\SentryBundle\Command\SentryTestCommand">
             <argument type="service" id="Sentry\State\HubInterface" />
 

tests/End2End/App/Command/CrashCommand.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Command;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CrashCommand extends Command
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var string
+     */
+    private $subcommand;
+
+    public function __construct(LoggerInterface $logger, ?string $subcommand = null)
+    {
+        parent::__construct();
+        $this->logger = $logger;
+        $this->subcommand = $subcommand;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->logger->warning('Executing subcommand if exists');
+
+        if (null !== $this->subcommand) {
+            $this->getApplication()->doRun(new ArgvInput(['bin/console', 'log:test']), $output);
+        }
+
+        $this->logger->emergency('About to crash');
+
+        throw new \RuntimeException('Crash in command');
+    }
+}

tests/End2End/App/Command/LoggingCommand.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Command;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class LoggingCommand extends Command
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(LoggerInterface $logger)
+    {
+        parent::__construct();
+        $this->logger = $logger;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->logger->debug('Debug Log');
+
+        $this->logger->info('Info Log');
+
+        $this->logger->warning('Warn Log');
+
+        $this->logger->error('Error Log');
+
+        return 0;
+    }
+}

tests/End2End/App/Controller/LoggingController.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Response;
+
+class LoggingController
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    public function justLogging()
+    {
+        // LogLevel::fatal()
+        $this->logger->emergency('Emergency Log');
+        $this->logger->critical('Critical Log');
+        // LogLevel::error()
+        $this->logger->error('Error Log');
+        // LogLevel::warn()
+        $this->logger->warning('Warn Log');
+        // LogLevel::info()
+        $this->logger->info('Info Log');
+        $this->logger->notice('Notice Log');
+        // LogLevel::debug()
+        $this->logger->debug('Debug Log');
+
+        return new Response();
+    }
+
+    public function loggingWithError()
+    {
+        $this->logger->emergency('Something is not right');
+        $this->logger->error('About to crash');
+        throw new \RuntimeException('Crash');
+    }
+}

tests/End2End/App/KernelWithLogging.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App;
+
+use Symfony\Component\Config\Loader\LoaderInterface;
+
+class KernelWithLogging extends Kernel
+{
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        parent::registerContainerConfiguration($loader);
+
+        $loader->load(__DIR__ . '/logging.yml');
+    }
+}

tests/End2End/App/logging.yml

@@ -0,0 +1,37 @@
+sentry:
+  options:
+    enable_logs: true
+
+monolog:
+  handlers:
+    sentry_logs:
+      type: service
+      id: Sentry\SentryBundle\Monolog\LogsHandler
+
+services:
+  Sentry\SentryBundle\Monolog\LogsHandler:
+    arguments:
+      - !php/const Monolog\Logger::WARNING
+
+  Sentry\SentryBundle\Tests\End2End\App\Controller\LoggingController:
+    autowire: true
+    tags:
+      - { name: controller.service_arguments }
+
+  Sentry\SentryBundle\Tests\End2End\App\Command\LoggingCommand:
+    autowire: true
+    tags: [ { name: 'console.command', command: 'log:test' } ]
+
+  Sentry\SentryBundle\Tests\End2End\App\Command\CrashCommand.nosub:
+    autowire: true
+    class: Sentry\SentryBundle\Tests\End2End\App\Command\CrashCommand
+    arguments:
+      $subcommand: null
+    tags: [ { name: 'console.command', command: 'log:nosub' } ]
+
+  Sentry\SentryBundle\Tests\End2End\App\Command\CrashCommand.sub:
+    autowire: true
+    class: Sentry\SentryBundle\Tests\End2End\App\Command\CrashCommand
+    arguments:
+      $subcommand: 'log:test'
+    tags: [ { name: 'console.command', command: 'log:sub' } ]

tests/End2End/App/routing.yml

@@ -42,6 +42,14 @@ tracing_ignored_transaction:
   path: /tracing/ignored-transaction
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::ignoredTransaction' }
 
+just_logging:
+  path: /just-logging
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\LoggingController::justLogging' }
+
+logging_With_Error:
+  path: /logging-with-error
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\LoggingController::loggingWithError' }
+
 buffer_flush:
   path: /buffer-flush
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\BufferFlushController::testBufferFlush' }