ref(logs): make API stable (remove Experimental from Options) (#4699)

Author: Flash0ver

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

@@ -22,16 +22,13 @@ public void Setup()
         SentryLoggingOptions options = new()
         {
             Dsn = DsnSamples.ValidDsn,
-            Experimental =
-            {
-                EnableLogs = true,
-            },
+            EnableLogs = true,
             ExperimentalLogging =
             {
                 MinimumLogLevel = LogLevel.Information,
             }
         };
-        options.Experimental.SetBeforeSendLog((SentryLog log) =>
+        options.SetBeforeSendLog((SentryLog log) =>
         {
             _lastLog = log;
             return null;

benchmarks/Sentry.Benchmarks/StructuredLogBatchProcessorBenchmarks.cs

@@ -22,10 +22,7 @@ public void Setup()
         SentryOptions options = new()
         {
             Dsn = DsnSamples.ValidDsn,
-            Experimental =
-            {
-                EnableLogs = true,
-            },
+            EnableLogs = true,
         };
 
         var batchInterval = Timeout.InfiniteTimeSpan;

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

@@ -17,7 +17,7 @@
 #endif
 
     // This option enables Logs sent to Sentry.
-    options.Experimental.EnableLogs = true;
+    options.EnableLogs = true;
 });
 
 var app = builder.Build();

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

@@ -38,8 +38,8 @@
     options.TracesSampleRate = 1.0;
 
     // This option enables Sentry Logs created via SentrySdk.Logger.
-    options.Experimental.EnableLogs = true;
-    options.Experimental.SetBeforeSendLog(static log =>
+    options.EnableLogs = true;
+    options.SetBeforeSendLog(static log =>
     {
         // A demonstration of how you can drop logs based on some attribute they have
         if (log.TryGetAttribute("suppress", out var attribute) && attribute is true)

samples/Sentry.Samples.ME.Logging/Program.cs

@@ -26,8 +26,8 @@
         options.ExperimentalLogging.MinimumLogLevel = LogLevel.Trace; // This level or above will result in log sent to Sentry
 
         // This option enables Logs sent to Sentry.
-        options.Experimental.EnableLogs = true;
-        options.Experimental.SetBeforeSendLog(static log =>
+        options.EnableLogs = true;
+        options.SetBeforeSendLog(static log =>
         {
             log.SetAttribute("attribute-key", "attribute-value");
             return log;

samples/Sentry.Samples.Maui/MauiProgram.cs

@@ -33,7 +33,7 @@ public static MauiApp CreateMauiApp()
                 options.AttachScreenshot = true;
 
                 options.Debug = true;
-                options.Experimental.EnableLogs = true;
+                options.EnableLogs = true;
                 options.SampleRate = 1.0F;
 
                 // The Sentry MVVM Community Toolkit integration automatically creates traces for async relay commands,

samples/Sentry.Samples.Serilog/Program.cs

@@ -26,7 +26,7 @@ private static void Main()
                 options.MinimumEventLevel = LogEventLevel.Error;
                 options.AttachStacktrace = true;
                 // send structured logs to Sentry
-                options.Experimental.EnableLogs = true;
+                options.EnableLogs = true;
                 // send PII like the username of the user logged in to the device
                 options.SendDefaultPii = true;
                 // Optional Serilog text formatter used to format LogEvent to string. If TextFormatter is set, FormatProvider is ignored.

src/Sentry.Extensions.Logging/SentryStructuredLogger.cs

@@ -29,7 +29,7 @@ internal SentryStructuredLogger(string categoryName, SentryLoggingOptions option
     public bool IsEnabled(LogLevel logLevel)
     {
         return _hub.IsEnabled
-            && _options.Experimental.EnableLogs
+            && _options.EnableLogs
             && logLevel != LogLevel.None
             && logLevel >= _options.ExperimentalLogging.MinimumLogLevel;
     }

src/Sentry.Serilog/SentrySink.cs

@@ -84,7 +84,7 @@ private bool IsEnabled(LogEvent logEvent)
 
         return logEvent.Level >= _options.MinimumEventLevel
             || logEvent.Level >= _options.MinimumBreadcrumbLevel
-            || options?.Experimental.EnableLogs is true;
+            || options?.EnableLogs is true;
     }
 
     private void InnerEmit(LogEvent logEvent)
@@ -169,7 +169,7 @@ private void InnerEmit(LogEvent logEvent)
         // In cases where Sentry's Serilog-Sink is added without a DSN (i.e., without initializing the SDK) and the SDK is initialized differently (e.g., through ASP.NET Core),
         // then the 'EnableLogs' option of this Sink's Serilog-Options is default, but the Hub's Sentry-Options have the actual user-defined value configured.
         var options = hub.GetSentryOptions();
-        if (options?.Experimental.EnableLogs is true)
+        if (options?.EnableLogs is true)
         {
             CaptureStructuredLog(hub, options, logEvent, formatted, template);
         }

src/Sentry.Serilog/SentrySinkExtensions.cs

@@ -35,7 +35,7 @@ public static class SentrySinkExtensions
     /// <param name="reportAssembliesMode">What mode to use for reporting referenced assemblies in each event sent to sentry. Defaults to <see cref="Sentry.ReportAssembliesMode.Version"/></param>
     /// <param name="deduplicateMode">What modes to use for event automatic de-duplication. <seealso cref="SentryOptions.DeduplicateMode"/></param>
     /// <param name="defaultTags">Default tags to add to all events. <seealso cref="SentryOptions.DefaultTags"/></param>
-    /// <param name="experimentalEnableLogs">Whether to send structured logs. <seealso cref="SentryOptions.SentryExperimentalOptions.EnableLogs"/></param>
+    /// <param name="enableLogs">Whether to send structured logs. <seealso cref="SentryOptions.EnableLogs"/></param>
     /// <returns><see cref="LoggerConfiguration"/></returns>
     /// <example>This sample shows how each item may be set from within a configuration file:
     /// <code>
@@ -73,7 +73,7 @@ public static class SentrySinkExtensions
     ///                         "key-1", "value-1",
     ///                         "key-2", "value-2"
     ///                     },
-    ///                     "experimentalEnableLogs": true
+    ///                     "enableLogs": true
     ///                 }
     ///             }
     ///         ]
@@ -106,7 +106,7 @@ public static LoggerConfiguration Sentry(
         ReportAssembliesMode? reportAssembliesMode = null,
         DeduplicateMode? deduplicateMode = null,
         Dictionary<string, string>? defaultTags = null,
-        bool? experimentalEnableLogs = null)
+        bool? enableLogs = null)
     {
         return loggerConfiguration.Sentry(o => ConfigureSentrySerilogOptions(o,
             dsn,
@@ -132,7 +132,7 @@ public static LoggerConfiguration Sentry(
             reportAssembliesMode,
             deduplicateMode,
             defaultTags,
-            experimentalEnableLogs));
+            enableLogs));
     }
 
     /// <summary>
@@ -210,7 +210,7 @@ internal static void ConfigureSentrySerilogOptions(
         ReportAssembliesMode? reportAssembliesMode = null,
         DeduplicateMode? deduplicateMode = null,
         Dictionary<string, string>? defaultTags = null,
-        bool? experimentalEnableLogs = null)
+        bool? enableLogs = null)
     {
         if (dsn is not null)
         {
@@ -322,9 +322,9 @@ internal static void ConfigureSentrySerilogOptions(
             sentrySerilogOptions.DeduplicateMode = deduplicateMode.Value;
         }
 
-        if (experimentalEnableLogs.HasValue)
+        if (enableLogs.HasValue)
         {
-            sentrySerilogOptions.Experimental.EnableLogs = experimentalEnableLogs.Value;
+            sentrySerilogOptions.EnableLogs = enableLogs.Value;
         }
 
         // Serilog-specific items