Reduced the logger noise from EF when not using Performance Monitoring (

#1441)

* Reduced the logger noise from EF when not using Performance Monitoring.

Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>

CHANGELOG.md

@@ -11,6 +11,7 @@
 
 ### Fixes
 
+- Reduced the logger noise from EF when not using Performance Monitoring ([#1441](https://github.com/getsentry/sentry-dotnet/pull/1441))
 - Create CachingTransport directories in constructor to avoid DirectoryNotFoundException ([#1432](https://github.com/getsentry/sentry-dotnet/pull/1432))
 
 ## 3.13.0

src/Sentry.EntityFramework/DbInterceptionIntegration.cs

@@ -1,17 +1,34 @@
 using System.Data.Entity.Infrastructure.Interception;
+using Sentry.Extensibility;
 using Sentry.Integrations;
 
 namespace Sentry.EntityFramework;
 
 internal class DbInterceptionIntegration : ISdkIntegration
 {
-    private IDbInterceptor? _sqlInterceptor { get; set; }
+    // Internal for testing.
+    internal IDbInterceptor? SqlInterceptor { get; private set; }
+
+    internal const string SampleRateDisabledMessage = "EF performance won't be collected because TracesSampleRate is set to 0.";
 
     public void Register(IHub hub, SentryOptions options)
     {
-        _sqlInterceptor = new SentryQueryPerformanceListener(hub, options);
-        DbInterception.Add(_sqlInterceptor);
+        if (options.TracesSampleRate == 0)
+        {
+            options.DiagnosticLogger?.LogInfo(SampleRateDisabledMessage);
+        }
+        else
+        {
+            SqlInterceptor = new SentryQueryPerformanceListener(hub, options);
+            DbInterception.Add(SqlInterceptor);
+        }
     }
 
-    public void Unregister() => DbInterception.Remove(_sqlInterceptor);
+    public void Unregister()
+    {
+        if (SqlInterceptor is { } interceptor)
+        {
+            DbInterception.Remove(interceptor);
+        }
+    }
 }

src/Sentry.EntityFramework/SentryQueryPerformanceListener.cs

@@ -68,9 +68,10 @@ private void Finish<T>(string key, DbCommandInterceptionContext<T> interceptionC
                 span.Finish(interceptionContext.Exception);
             }
         }
-        else
+        //Only log if there was a transaction on the Hub.
+        else if (_options.DiagnosticLevel == SentryLevel.Debug && _hub.GetSpan() is { })
         {
-            _options.DiagnosticLogger?.LogWarning("Span with key {0} was not found on interceptionContext.", key);
+            _options.DiagnosticLogger?.LogDebug("Span with key {0} was not found on interceptionContext.", key);
         }
     }
 }

test/Sentry.EntityFramework.Tests/DbInterceptionIntegrationTests.cs

@@ -0,0 +1,28 @@
+using Sentry.Testing;
+
+namespace Sentry.EntityFramework.Tests
+{
+    public class DbInterceptionIntegrationTests
+    {
+        [Fact]
+        public void Register_TraceSAmpleRateZero_IntegrationNotRegistered()
+        {
+            // Arrange
+            var logger = Substitute.For<ITestOutputHelper>();
+            var options = new SentryOptions()
+            {
+                Debug = true,
+                DiagnosticLogger = new TestOutputDiagnosticLogger(logger, SentryLevel.Debug),
+                TracesSampleRate = 0
+            };
+            var integration = new DbInterceptionIntegration();
+
+            // Act
+            integration.Register(Substitute.For<IHub>(), options);
+
+            // Assert
+            logger.Received(1).WriteLine(Arg.Is<string>(message => message.Contains(DbInterceptionIntegration.SampleRateDisabledMessage)));
+            Assert.Null(integration.SqlInterceptor);
+        }
+    }
+}

test/Sentry.EntityFramework.Tests/SentryQueryPerformanceListenerTests.cs

@@ -2,6 +2,7 @@
 using System.Data.Common;
 using System.Data.Entity.Infrastructure.Interception;
 using Effort.Provider;
+using Sentry.Testing;
 
 namespace Sentry.EntityFramework.Tests;
 
@@ -199,7 +200,7 @@ public void FirstOrDefault_FromDatabase_CapturesQuery()
     {
         // Arrange
         var integration = new DbInterceptionIntegration();
-        integration.Register(_fixture.Hub, new SentryOptions());
+        integration.Register(_fixture.Hub, new SentryOptions() { TracesSampleRate = 1 });
 
         // Act
         _ = _fixture.DbContext.TestTable.FirstOrDefault();
@@ -221,4 +222,27 @@ public void FirstOrDefault_FromDatabase_CapturesQuery()
         });
         integration.Unregister();
     }
+
+    [Fact]
+    public void Finish_NoActiveTransaction_LoggerNotCalled()
+    {
+        // Arrange
+        var hub = _fixture.Hub;
+        hub.GetSpan().Returns((_) => null);
+        var logger = Substitute.For<ITestOutputHelper>();
+
+        var options = new SentryOptions()
+        {
+            Debug = true,
+            DiagnosticLogger = new TestOutputDiagnosticLogger(logger, SentryLevel.Debug)
+        };
+
+        var listener = new SentryQueryPerformanceListener(hub, options);
+
+        // Act
+        listener.ScalarExecuted(Substitute.For<DbCommand>(), Substitute.For<DbCommandInterceptionContext<object>>());
+
+        // Assert
+        logger.Received(0).WriteLine(Arg.Any<string>());
+    }
 }