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

[Flash0ver]

Fixes #4539
Fixes #4734

• Logging-Configuration is not applied to Sentry-Logger-Provider #4539
• Sentry Logging should respect the user's global ILogger filter(s). #4734

---

Summary

Previously, the Logging-Configuration was inconsistent between SDKs (M.E.L, ASP.NET Core, MAUI, Google-Cloud-Functions):

• M.E.L correctly ignores Logging-Configuration for Breadcrumbs and Events
• ASP.NET Core, MAUI and Google-Cloud-Functions were incorrectly considering Logging-Configuration for Breadcrumbs and Events
• all (M.E.L, ASP.NET Core and MAUI) were incorrectly ignoring Logging-Configuration for Structured Logs
• Google-Cloud-Functions did not support Structured Logs

This changeset is normalizing the applied Logging-Filter-Rules across all integrations:
Logging-Configuration (i.e. Logging:LogLevel:Default and Logging:Sentry:LogLevel:Default via e.g. appsettings.json) is now respected for Structured Logs, but now ignored for Breadcrumbs and Events, since we have existing MinimumBreadcrumbLevel and MinimumEventLevel, as well as AddLogEntryFilter extension methods for filtering Breadcrumbs and Events.

New

• Sentry.Google.Cloud.Functions now supports Structured Logs
  • when enabled via EnableLogs = true

Changed

• remove SentryLoggingOptions.ExperimentalLogging.MinimumLogLevel for Structured-Logs
  • instead, allow configuration of Structured-Logs via the "Sentry" logging provider name
• the minimum Log-Level Configuration (appsettings.json) now only applies to Structured Logging
• the minimum Log-Level Configuration (appsettings.json) no longer applies to Breadcrumbs
  • instead, configure via the already existing SentryLoggingOptions.MinimumBreadcrumbLevel and SentryLoggingOptionsExtensions.AddLogEntryFilter
• the minimum Log-Level Configuration (appsettings.json) no longer applies to Events
  • instead, configure via the already existing SentryLoggingOptions.MinimumEventLevel and SentryLoggingOptionsExtensions.AddLogEntryFilter
• made all types that implement ILoggerProvider and IConfigureOptions internal
  • in order to ensure that LoggerFilterRules are correctly set
  • none of the now non-public types were mentioned in sentry-docs
• SentryStructuredLoggerProvider (and derived for ASP.NET Core and MAUI) now have [ProviderAlias("Sentry")]
  • in order to enable appsettings.json configuration for Structured Logs

Testing

• added Tests that ensure that the Logging-Filters are correctly setup (via Microsoft.Extensions.Logging.LoggerFilterRule)
  • SentryLoggerProvider (and derived) is NOT configurable via appsettings.json (for Breadcrumbs and Events)
    • by having a related non-null LoggerFilterRule.Filter
  • SentryStructuredLoggerProvider (and derived) IS configurable via appsettings.json (via the "Sentry" logging provider name)
    • with the related LoggerFilterRule.Filter being null
• added missing tests for consistency between the ILoggerProvider for Breadcrumbs/Events and the ILoggerProvider for Structured Logs

Samples

• added / updated the appsettings.json of these samples to show how to configure Structured Logs, in contrast to Breadcrumbs and Events
  • Sentry.Samples.AspNetCore.Basic
  • Sentry.Samples.GenericHost
  • Sentry.Samples.Google.Cloud.Functions

Important

This functionality relies on a quirk/feature of Microsoft.Extensions.Logging.LoggerFilterRule. When a filter delegate is configured, filtering via configuration bindings are ignored and only the filtering delegate is applied. When not using a filter delegate, log filtering from configuration bindings does get applied.

[codecov]

Codecov Report

❌ Patch coverage is 91.66667% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.91%. Comparing base (ac97aef) to head (b26b3b0).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...tensions.Logging/SentryStructuredLoggerProvider.cs	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4700      +/-   ##
==========================================
+ Coverage   73.85%   73.91%   +0.05%     
==========================================
  Files         485      485              
  Lines       17689    17686       -3     
  Branches     3497     3494       -3     
==========================================
+ Hits        13065    13072       +7     
+ Misses       3762     3756       -6     
+ Partials      862      858       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Flash0ver]

@sentry review

[ericsampson]

@Flash0ver do you think this is going into an RC3 ? Thanks

[Flash0ver]

@ericsampson, actually, this will be in 6.0.0 GA ... soon ... in the next couple of days.