Add the logger config option to ease setting a PSR-3 logger to debug the SDK (#538)

Author: ste93cry

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Add the `sentry_trace_meta()` Twig function to print the `sentry-trace` HTML meta tag (#510)
 - Make the list of commands for which distributed tracing is active configurable (#515)
 - Introduce `TracingDriverConnection::getWrappedConnection()` (#536)
+- Add the `logger` config option to ease setting a PSR-3 logger to debug the SDK (#538)
 
 ## 4.1.4 (2021-06-18)
 

src/DependencyInjection/Configuration.php

@@ -36,6 +36,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->info('If this value is not provided, the SDK will try to read it from the SENTRY_DSN environment variable. If that variable also does not exist, the SDK will just not send any events.')
                 ->end()
                 ->booleanNode('register_error_listener')->defaultTrue()->end()
+                ->scalarNode('logger')
+                    ->info('The service ID of the PSR-3 logger used to log messages coming from the SDK client. Be aware that setting the same logger of the application may create a circular loop when an event fails to be sent.')
+                    ->defaultNull()
+                ->end()
                 ->scalarNode('transport_factory')
                     ->info('The service ID of the transport factory used by the default SDK client.')
                     ->defaultValue(TransportFactoryInterface::class)

src/DependencyInjection/SentryExtension.php

@@ -7,6 +7,7 @@
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Jean85\PrettyVersions;
 use LogicException;
+use Psr\Log\NullLogger;
 use Sentry\Client;
 use Sentry\ClientBuilder;
 use Sentry\Integration\IgnoreErrorsIntegration;
@@ -129,7 +130,8 @@ private function registerConfiguration(ContainerBuilder $container, array $confi
             ->addMethodCall('setSdkVersion', [PrettyVersions::getVersion('sentry/sentry-symfony')->getPrettyVersion()])
             ->addMethodCall('setTransportFactory', [new Reference($config['transport_factory'])])
             ->addMethodCall('setSerializer', [$serializer])
-            ->addMethodCall('setRepresentationSerializer', [$representationSerializerDefinition]);
+            ->addMethodCall('setRepresentationSerializer', [$representationSerializerDefinition])
+            ->addMethodCall('setLogger', [null !== $config['logger'] ? new Reference($config['logger']) : new Reference(NullLogger::class, ContainerBuilder::IGNORE_ON_INVALID_REFERENCE)]);
 
         $container
             ->setDefinition('sentry.client', new Definition(Client::class))

src/Resources/config/schema/sentry-1.0.xsd

@@ -17,6 +17,7 @@
         <xsd:attribute name="register-error-listener" type="xsd:boolean" />
         <xsd:attribute name="transport-factory" type="xsd:string" />
         <xsd:attribute name="dsn" type="xsd:string" />
+        <xsd:attribute name="logger" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:complexType name="options">

tests/DependencyInjection/ConfigurationTest.php

@@ -20,6 +20,7 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
     {
         $expectedBundleDefaultConfig = [
             'register_error_listener' => true,
+            'logger' => null,
             'transport_factory' => 'Sentry\\Transport\\TransportFactoryInterface',
             'options' => [
                 'integrations' => [],

tests/DependencyInjection/Fixtures/php/full.php

@@ -8,6 +8,7 @@
 $container->loadFromExtension('sentry', [
     'dsn' => 'https://[email protected]/0',
     'transport_factory' => 'App\\Sentry\\Transport\\TransportFactory',
+    'logger' => 'app.logger',
     'options' => [
         'integrations' => ['App\\Sentry\\Integration\\FooIntegration'],
         'default_integrations' => false,

tests/DependencyInjection/Fixtures/php/logger_service_not_set.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/** @var ContainerBuilder $container */
+$container->loadFromExtension('sentry', [
+    'logger' => null,
+]);

tests/DependencyInjection/Fixtures/xml/full.xml

@@ -9,6 +9,7 @@
     <sentry:config
         dsn="https://[email protected]/0"
         transport-factory="App\Sentry\Transport\TransportFactory"
+        logger="app.logger"
     >
         <sentry:options default-integrations="false"
                         send-attempts="1"

tests/DependencyInjection/Fixtures/xml/logger_service_not_set.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xmlns:sentry="https://sentry.io/schema/dic/sentry-symfony"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+                               https://sentry.io/schema/dic/sentry-symfony https://sentry.io/schema/dic/sentry-symfony/sentry-1.0.xsd">
+
+    <sentry:config logger="null" />
+</container>

tests/DependencyInjection/Fixtures/yml/full.yml

@@ -1,6 +1,7 @@
 sentry:
     dsn: https://[email protected]/0
     transport_factory: App\Sentry\Transport\TransportFactory
+    logger: app.logger
     options:
         integrations:
             - App\Sentry\Integration\FooIntegration

tests/DependencyInjection/Fixtures/yml/logger_service_not_set.yml

@@ -0,0 +1,2 @@
+sentry:
+    logger: ~

tests/DependencyInjection/SentryExtensionTest.php

@@ -7,6 +7,7 @@
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Jean85\PrettyVersions;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
 use Sentry\ClientInterface;
 use Sentry\Integration\IgnoreErrorsIntegration;
 use Sentry\Options;
@@ -231,6 +232,7 @@ public function testClentIsCreatedFromOptions(): void
         $this->assertDefinitionMethodCallAt($methodCalls[0], 'setSdkIdentifier', [SentryBundle::SDK_IDENTIFIER]);
         $this->assertDefinitionMethodCallAt($methodCalls[1], 'setSdkVersion', [PrettyVersions::getVersion('sentry/sentry-symfony')->getPrettyVersion()]);
         $this->assertDefinitionMethodCallAt($methodCalls[2], 'setTransportFactory', [new Reference('App\\Sentry\\Transport\\TransportFactory')]);
+        $this->assertDefinitionMethodCallAt($methodCalls[5], 'setLogger', [new Reference('app.logger')]);
 
         $this->assertSame('setSerializer', $methodCalls[3][0]);
         $this->assertInstanceOf(Definition::class, $methodCalls[3][1][0]);
@@ -369,6 +371,16 @@ public function testConsoleTracingListenerIsConfiguredWhenTracingIsEnabled(): vo
         $this->assertSame(['foo:bar', 'bar:foo'], $container->getDefinition(TracingConsoleListener::class)->getArgument(1));
     }
 
+    public function testLoggerOptionFallbackToNullLoggerIfNotSet(): void
+    {
+        $container = $this->createContainerFromFixture('logger_service_not_set');
+        $clientDefinition = $container->findDefinition(ClientInterface::class);
+        $factory = $clientDefinition->getFactory();
+        $methodCalls = $factory[0]->getMethodCalls();
+
+        $this->assertDefinitionMethodCallAt($methodCalls[5], 'setLogger', [new Reference(NullLogger::class, ContainerBuilder::IGNORE_ON_INVALID_REFERENCE)]);
+    }
+
     private function createContainerFromFixture(string $fixtureFile): ContainerBuilder
     {
         $container = new ContainerBuilder(new EnvPlaceholderParameterBag([