fix(logs)!: minimum Log-Level for Structured Logs (#4700)

Author: Flash0ver

CHANGELOG.md

@@ -2,8 +2,23 @@
 
 ## Unreleased
 
+### BREAKING CHANGES
+
+- Remove `SentryLoggingOptions.ExperimentalLogging.MinimumLogLevel`. _Structured Logs_ can now be configured via the `"Sentry"` logging provider (e.g. in `appsettings.json` and `appsettings.{HostEnvironment}.json`) ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
+- All logging provider types are _internal_ now in order to ensure configuration as intended ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
+
+### Features
+
+- Add support for _Structured Logs_ in `Sentry.Google.Cloud.Functions` ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
+
 ### Fixes
 
+- Minimum Log-Level for _Structured Logs_, _Breadcrumbs_ and _Events_ in all Logging-Integrations ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
+  - for `Sentry.Extensions.Logging`, `Sentry.AspNetCore`, `Sentry.Maui` and `Sentry.Google.Cloud.Functions`
+  - the Logger-Provider for _Breadcrumbs_ and _Events_ ignores Logging-Configuration (e.g. via `appsettings.json`)
+    - use the intended `SentryLoggingOptions.MinimumBreadcrumbLevel`, `SentryLoggingOptions.MinimumEventLevel`, or add filter functions via `SentryLoggingOptionsExtensions.AddLogEntryFilter`
+  - the Logger-Provider for _Structured Logs_ respects Logging-Configuration (e.g. via `appsettings.json`)
+    - when enabled by `SentryOptions.EnableLogs`
 - Avoid appending `/NODEFAULTLIB:MSVCRT` to NativeAOT linker arguments on Windows when targetting non-Windows platforms (Android, Browser) ([#4760](https://github.com/getsentry/sentry-dotnet/pull/4760))
 
 ## 6.0.0-rc.2

benchmarks/Sentry.Benchmarks/Extensions.Logging/SentryStructuredLoggerBenchmarks.cs

@@ -23,10 +23,6 @@ public void Setup()
         {
             Dsn = DsnSamples.ValidDsn,
             EnableLogs = true,
-            ExperimentalLogging =
-            {
-                MinimumLogLevel = LogLevel.Information,
-            }
         };
         options.SetBeforeSendLog((SentryLog log) =>
         {

samples/Sentry.Samples.AspNetCore.Basic/Program.cs

@@ -16,7 +16,12 @@
     options.Debug = true;
 #endif
 
-    // This option enables Logs sent to Sentry.
+    // Configure the minimum Log Level of Breadcrumbs and Events
+    options.MinimumBreadcrumbLevel = LogLevel.Information;
+    options.MinimumEventLevel = LogLevel.Error;
+
+    // This option enables Logs sent to Sentry
+    // Configure the minimum Log Level of Structured-Logs via e.g. "appsettings.json" and "appsettings.{HostEnvironment}.json"
     options.EnableLogs = true;
 });
 

samples/Sentry.Samples.AspNetCore.Basic/appsettings.json

@@ -0,0 +1,14 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    },
+    "Sentry": {
+      "LogLevel": {
+        "Default": "Trace"
+      }
+    }
+  },
+  "AllowedHosts": "*"
+}

samples/Sentry.Samples.AspNetCore.Grpc/appsettings.json

@@ -23,12 +23,20 @@
     "DiagnosticLevel": "Error",
     "DefaultTags": {
       "default-key-in-config": "default-value"
-    }
+    },
+    // Record log messages as Structured Logs (configure via "Logging" section)
+    "EnableLogs": true
   },
   "Logging": {
     "IncludeScopes": false,
     "LogLevel": {
       "Default": "Trace"
+    },
+    // Configure the "Sentry" provider for Structured Logs
+    "Sentry": {
+      "LogLevel": {
+        "Default": "Information"
+      }
     }
   },
   "Kestrel": {

samples/Sentry.Samples.AspNetCore.Mvc/appsettings.json

@@ -23,12 +23,20 @@
     "DiagnosticLevel": "Error",
     "DefaultTags": {
       "default-key-in-config": "default-value"
-    }
+    },
+    // Record log messages as Structured Logs (configure via "Logging" section)
+    "EnableLogs": true
   },
   "Logging": {
     "LogLevel": {
       "Default": "Information",
       "Microsoft.AspNetCore": "Warning"
+    },
+    // Configure the "Sentry" provider for Structured Logs
+    "Sentry": {
+      "LogLevel": {
+        "Default": "Warning"
+      }
     }
   },
   "AllowedHosts": "*"

samples/Sentry.Samples.GenericHost/SampleHostedService.cs

@@ -7,6 +7,8 @@ internal class SampleHostedService(IHub hub, ILogger<SampleHostedService> logger
 {
     public Task StartAsync(CancellationToken cancellationToken)
     {
+        // Configure structured logging via appsettings.json (Logging:Sentry:LogLevel:)
+        logger.LogTrace("LogLevel.Trace is not configured to be sent as structured log");
         // Logging integration by default keeps informational logs as Breadcrumb
         logger.LogInformation("Starting sample hosted service. This goes as a breadcrumb");
         // You can also add breadcrumb directly through Sentry.Hub:

samples/Sentry.Samples.GenericHost/appsettings.json

@@ -2,12 +2,18 @@
   "Logging": {
     "LogLevel": {
       "Default": "Trace"
+    },
+    "Sentry": {
+      "LogLevel": {
+        "Default": "Information" // Configure structured logs
+      }
     }
   },
   "Sentry": {
     //"Dsn": "TODO: Configure your DSN here and uncomment this line",
     "MinimumBreadcrumbLevel": "Debug",
     "MinimumEventLevel": "Warning",
-    "SendDefaultPii": true // Send user name and machine name
+    "SendDefaultPii": true, // Send user name and machine name
+    "EnableLogs": true // Send structured logs
   }
 }

samples/Sentry.Samples.Google.Cloud.Functions/Function.cs

@@ -12,11 +12,18 @@
 public class Function : IHttpFunction
 {
     private readonly ILogger<Function> _logger;
+
     public Function(ILogger<Function> logger) => _logger = logger;
 
     public Task HandleAsync(HttpContext context)
     {
+        // Configure structured logging via appsettings.json (Logging:Sentry:LogLevel:)
+        _logger.LogTrace("LogLevel.Trace is not configured to be sent as structured log");
+
+        // Logging integration by default keeps informational logs as Breadcrumb
         _logger.LogInformation("Useful info that is added to the breadcrumb list.");
+
+        // Results in an Event/Error in Sentry, including the Breadcrumb from above
         throw new Exception("Bad function");
     }
 }

samples/Sentry.Samples.Google.Cloud.Functions/appsettings.json

@@ -1,8 +1,19 @@
 {
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug"
+    },
+    "Sentry": {
+      "LogLevel": {
+        "Default": "Information"
+      }
+    }
+  },
   "Sentry": {
     //"Dsn": "TODO: Configure your DSN here and uncomment this line",
     "MaxRequestBodySize": "Always",
     "SendDefaultPii": true,
-    "EnableTracing": true
+    "EnableTracing": true,
+    "EnableLogs" : true
   }
 }