Log to Console and Debug when targeting MAUI

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Fixes
 
+- Debug logs are now visible for MAUI apps in Visual Studio when using Sentry's default DiagnosticLogger ([#3373](https://github.com/getsentry/sentry-dotnet/pull/3373))
 - Fixed Monitor duration calculation ([#3420]https://github.com/getsentry/sentry-dotnet/pull/3420)
 - Fixed null IServiceProvider in anonymous routes with OpenTelemetry ([#3401](https://github.com/getsentry/sentry-dotnet/pull/3401))
 - Fixed Trim warnings in Sentry.DiagnosticSource and WinUIUnhandledException integrations ([#3410](https://github.com/getsentry/sentry-dotnet/pull/3410))

src/Sentry.Maui/Internal/SentryMauiOptionsSetup.cs

@@ -2,6 +2,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Options;
 using Microsoft.Maui.Networking;
+using Sentry.Infrastructure;
 
 namespace Sentry.Maui.Internal;
 
@@ -36,6 +37,12 @@ public void Configure(SentryMauiOptions options)
         // Global Mode makes sense for client apps
         options.IsGlobalModeEnabled = true;
 
+        // So debug logs are visible in both Rider and Visual Studio
+        if (options is { Debug: true, DiagnosticLogger: null })
+        {
+            options.DiagnosticLogger = new ConsoleAndTraceDiagnosticLogger(options.DiagnosticLevel);
+        }
+
         // We'll use an event processor to set things like SDK name
         options.AddEventProcessor(new SentryMauiEventProcessor(options));
 

src/Sentry/Infrastructure/ConsoleAndTraceDiagnosticLogger.cs

@@ -0,0 +1,22 @@
+namespace Sentry.Infrastructure;
+
+/// <summary>
+/// Logger that logs to both Console and Trace outputs, used in MAUI applications by default, since Visual Studio
+/// only show's Trace outputs and Rider shows Console outputs.
+/// </summary>
+public class ConsoleAndTraceDiagnosticLogger : DiagnosticLogger
+{
+    /// <summary>
+    /// Creates a new instance of <see cref="ConsoleAndTraceDiagnosticLogger"/>.
+    /// </summary>
+    public ConsoleAndTraceDiagnosticLogger(SentryLevel minimalLevel) : base(minimalLevel)
+    {
+    }
+
+    /// <inheritdoc />
+    protected override void LogMessage(string message)
+    {
+        Console.WriteLine(message);
+        Trace.WriteLine(message);
+    }
+}

test/Sentry.Maui.Tests/SentryMauiAppBuilderExtensionsTests.cs

@@ -251,4 +251,65 @@ public void UseSentry_WithCaching_CanChangeCacheDirectoryPath()
         // Assert
         Assert.Equal(cachePath, options.CacheDirectoryPath);
     }
+
+    [Fact]
+    public void UseSentry_DebugFalse_LoggerLeftDefault()
+    {
+        // Arrange
+        var builder = _fixture.Builder;
+
+        // Act
+        builder.UseSentry(options =>
+        {
+            options.Debug = false;
+            options.Dsn = ValidDsn;
+        });
+
+        using var app = builder.Build();
+        var options = app.Services.GetRequiredService<IOptions<SentryMauiOptions>>().Value;
+
+        // Assert
+        options.DiagnosticLogger.Should().BeNull();
+    }
+
+    [Fact]
+    public void UseSentry_DebugTrue_ConsoleAndTracingDiagnosticsLogger()
+    {
+        // Arrange
+        var builder = _fixture.Builder;
+
+        // Act
+        builder.UseSentry(options =>
+        {
+            options.Debug = true;
+            options.Dsn = ValidDsn;
+        });
+
+        using var app = builder.Build();
+        var options = app.Services.GetRequiredService<IOptions<SentryMauiOptions>>().Value;
+
+        // Assert
+        options.DiagnosticLogger.Should().BeOfType<ConsoleAndTraceDiagnosticLogger>();
+    }
+
+    [Fact]
+    public void UseSentry_DebugTrue_CustomDiagnosticsLogger()
+    {
+        // Arrange
+        var builder = _fixture.Builder;
+
+        // Act
+        builder.UseSentry(options =>
+        {
+            options.Debug = true;
+            options.Dsn = ValidDsn;
+            options.DiagnosticLogger = new TraceDiagnosticLogger(SentryLevel.Fatal);
+        });
+
+        using var app = builder.Build();
+        var options = app.Services.GetRequiredService<IOptions<SentryMauiOptions>>().Value;
+
+        // Assert
+        options.DiagnosticLogger.Should().BeOfType<TraceDiagnosticLogger>();
+    }
 }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt

@@ -1455,6 +1455,11 @@ namespace Sentry.Http
 }
 namespace Sentry.Infrastructure
 {
+    public class ConsoleAndTraceDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
+    {
+        public ConsoleAndTraceDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }
+        protected override void LogMessage(string message) { }
+    }
     public class ConsoleDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
     {
         public ConsoleDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt

@@ -1455,6 +1455,11 @@ namespace Sentry.Http
 }
 namespace Sentry.Infrastructure
 {
+    public class ConsoleAndTraceDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
+    {
+        public ConsoleAndTraceDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }
+        protected override void LogMessage(string message) { }
+    }
     public class ConsoleDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
     {
         public ConsoleDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -1457,6 +1457,11 @@ namespace Sentry.Http
 }
 namespace Sentry.Infrastructure
 {
+    public class ConsoleAndTraceDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
+    {
+        public ConsoleAndTraceDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }
+        protected override void LogMessage(string message) { }
+    }
     public class ConsoleDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
     {
         public ConsoleDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }

test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt

@@ -1452,6 +1452,11 @@ namespace Sentry.Http
 }
 namespace Sentry.Infrastructure
 {
+    public class ConsoleAndTraceDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
+    {
+        public ConsoleAndTraceDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }
+        protected override void LogMessage(string message) { }
+    }
     public class ConsoleDiagnosticLogger : Sentry.Infrastructure.DiagnosticLogger
     {
         public ConsoleDiagnosticLogger(Sentry.SentryLevel minimalLevel) { }