ref(logs): reorder parameters

Author: Flash0ver

src/Sentry.Serilog/SentrySinkExtensions.cs

@@ -13,11 +13,10 @@ public static class SentrySinkExtensions
     /// </summary>
     /// <param name="loggerConfiguration">The logger configuration .<seealso cref="LoggerSinkConfiguration"/></param>
     /// <param name="dsn">The Sentry DSN (required). <seealso cref="SentryOptions.Dsn"/></param>
-    /// <param name="minimumEventLevel">Minimum log level to send an event. <seealso cref="SentrySerilogOptions.MinimumEventLevel"/></param>
     /// <param name="minimumBreadcrumbLevel">Minimum log level to record a breadcrumb. <seealso cref="SentrySerilogOptions.MinimumBreadcrumbLevel"/></param>
+    /// <param name="minimumEventLevel">Minimum log level to send an event. <seealso cref="SentrySerilogOptions.MinimumEventLevel"/></param>
     /// <param name="formatProvider">The Serilog format provider. <seealso cref="IFormatProvider"/></param>
     /// <param name="textFormatter">The Serilog text formatter. <seealso cref="ITextFormatter"/></param>
-    /// <param name="experimentalEnableLogs">Whether to send structured logs. <seealso cref="SentryOptions.SentryExperimentalOptions.EnableLogs"/></param>
     /// <param name="sendDefaultPii">Whether to include default Personal Identifiable information. <seealso cref="SentryOptions.SendDefaultPii"/></param>
     /// <param name="isEnvironmentUser">Whether to report the <see cref="System.Environment.UserName"/> as the User affected in the event. <seealso cref="SentryOptions.IsEnvironmentUser"/></param>
     /// <param name="serverName">Gets or sets the name of the server running the application. <seealso cref="SentryOptions.ServerName"/></param>
@@ -36,6 +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>
     /// <returns><see cref="LoggerConfiguration"/></returns>
     /// <example>This sample shows how each item may be set from within a configuration file:
     /// <code>
@@ -52,7 +52,6 @@ public static class SentrySinkExtensions
     ///                     "minimumBreadcrumbLevel": "Verbose",
     ///                     "minimumEventLevel": "Error",
     ///                     "outputTemplate": "{Timestamp:o} [{Level:u3}] ({Application}/{MachineName}/{ThreadId}) {Message}{NewLine}{Exception}",
-    ///                     "experimentalEnableLogs": true,
     ///                     "sendDefaultPii": false,
     ///                     "isEnvironmentUser": false,
     ///                     "serverName": "MyServerName",
@@ -73,7 +72,8 @@ public static class SentrySinkExtensions
     ///                     "defaultTags": {
     ///                         "key-1", "value-1",
     ///                         "key-2", "value-2"
-    ///                     }
+    ///                     },
+    ///                     "experimentalEnableLogs": true
     ///                 }
     ///             }
     ///         ]
@@ -88,7 +88,6 @@ public static LoggerConfiguration Sentry(
         LogEventLevel? minimumEventLevel = null,
         IFormatProvider? formatProvider = null,
         ITextFormatter? textFormatter = null,
-        bool? experimentalEnableLogs = null,
         bool? sendDefaultPii = null,
         bool? isEnvironmentUser = null,
         string? serverName = null,
@@ -106,15 +105,15 @@ public static LoggerConfiguration Sentry(
         SentryLevel? diagnosticLevel = null,
         ReportAssembliesMode? reportAssembliesMode = null,
         DeduplicateMode? deduplicateMode = null,
-        Dictionary<string, string>? defaultTags = null)
+        Dictionary<string, string>? defaultTags = null,
+        bool? experimentalEnableLogs = null)
     {
         return loggerConfiguration.Sentry(o => ConfigureSentrySerilogOptions(o,
             dsn,
             minimumEventLevel,
             minimumBreadcrumbLevel,
             formatProvider,
             textFormatter,
-            experimentalEnableLogs,
             sendDefaultPii,
             isEnvironmentUser,
             serverName,
@@ -132,7 +131,8 @@ public static LoggerConfiguration Sentry(
             diagnosticLevel,
             reportAssembliesMode,
             deduplicateMode,
-            defaultTags));
+            defaultTags,
+            experimentalEnableLogs));
     }
 
     /// <summary>
@@ -186,7 +186,7 @@ public static LoggerConfiguration Sentry(
             minimumBreadcrumbLevel,
             formatProvider,
             textFormatter,
-            experimentalEnableLogs));
+            experimentalEnableLogs: experimentalEnableLogs));
     }
 
     internal static void ConfigureSentrySerilogOptions(
@@ -196,7 +196,6 @@ internal static void ConfigureSentrySerilogOptions(
         LogEventLevel? minimumBreadcrumbLevel = null,
         IFormatProvider? formatProvider = null,
         ITextFormatter? textFormatter = null,
-        bool? experimentalEnableLogs = null,
         bool? sendDefaultPii = null,
         bool? isEnvironmentUser = null,
         string? serverName = null,
@@ -214,7 +213,8 @@ internal static void ConfigureSentrySerilogOptions(
         SentryLevel? diagnosticLevel = null,
         ReportAssembliesMode? reportAssembliesMode = null,
         DeduplicateMode? deduplicateMode = null,
-        Dictionary<string, string>? defaultTags = null)
+        Dictionary<string, string>? defaultTags = null,
+        bool? experimentalEnableLogs = null)
     {
         if (dsn is not null)
         {
@@ -241,11 +241,6 @@ internal static void ConfigureSentrySerilogOptions(
             sentrySerilogOptions.TextFormatter = textFormatter;
         }
 
-        if (experimentalEnableLogs.HasValue)
-        {
-            sentrySerilogOptions.Experimental.EnableLogs = experimentalEnableLogs.Value;
-        }
-
         if (sendDefaultPii.HasValue)
         {
             sentrySerilogOptions.SendDefaultPii = sendDefaultPii.Value;
@@ -331,6 +326,11 @@ internal static void ConfigureSentrySerilogOptions(
             sentrySerilogOptions.DeduplicateMode = deduplicateMode.Value;
         }
 
+        if (experimentalEnableLogs.HasValue)
+        {
+            sentrySerilogOptions.Experimental.EnableLogs = experimentalEnableLogs.Value;
+        }
+
         // Serilog-specific items
         sentrySerilogOptions.InitializeSdk = dsn is not null;  // Inferred from the Sentry overload that is used
         if (defaultTags?.Count > 0)

test/Sentry.Serilog.Tests/SentrySerilogOptionsTests.cs

@@ -15,11 +15,4 @@ public void Ctor_MinimumEventLevel_Error()
         var sut = new SentrySerilogOptions();
         Assert.Equal(LogEventLevel.Error, sut.MinimumEventLevel);
     }
-
-    [Fact]
-    public void Ctor_EnableLogs_False()
-    {
-        var sut = new SentrySerilogOptions();
-        Assert.False(sut.Experimental.EnableLogs);
-    }
 }

test/Sentry.Serilog.Tests/SentrySerilogSinkExtensionsTests.cs

@@ -93,15 +93,14 @@ public void ConfigureSentrySerilogOptions_WithAllParameters_MakesAppropriateChan
         var sut = Fixture.GetSut();
 
         SentrySinkExtensions.ConfigureSentrySerilogOptions(sut, _fixture.Dsn, _fixture.MinimumEventLevel,
-            _fixture.MinimumBreadcrumbLevel, null, null, _fixture.ExperimentalEnableLogs, _fixture.SendDefaultPii,
+            _fixture.MinimumBreadcrumbLevel, null, null, _fixture.SendDefaultPii,
             _fixture.IsEnvironmentUser, _fixture.ServerName, _fixture.AttachStackTrace, _fixture.MaxBreadcrumbs,
             _fixture.SampleRate, _fixture.Release, _fixture.Environment, _fixture.MaxQueueItems,
             _fixture.ShutdownTimeout, _fixture.DecompressionMethods, _fixture.RequestBodyCompressionLevel,
             _fixture.RequestBodyCompressionBuffered, _fixture.Debug, _fixture.DiagnosticLevel,
-            _fixture.ReportAssembliesMode, _fixture.DeduplicateMode);
+            _fixture.ReportAssembliesMode, _fixture.DeduplicateMode, null, _fixture.ExperimentalEnableLogs);
 
         // Compare individual properties
-        Assert.Equal(_fixture.ExperimentalEnableLogs, sut.Experimental.EnableLogs);
         Assert.Equal(_fixture.SendDefaultPii, sut.SendDefaultPii);
         Assert.Equal(_fixture.IsEnvironmentUser, sut.IsEnvironmentUser);
         Assert.Equal(_fixture.ServerName, sut.ServerName);
@@ -120,6 +119,7 @@ public void ConfigureSentrySerilogOptions_WithAllParameters_MakesAppropriateChan
         Assert.Equal(_fixture.DiagnosticLevel, sut.DiagnosticLevel);
         Assert.Equal(_fixture.ReportAssembliesMode, sut.ReportAssembliesMode);
         Assert.Equal(_fixture.DeduplicateMode, sut.DeduplicateMode);
+        Assert.Equal(_fixture.ExperimentalEnableLogs, sut.Experimental.EnableLogs);
         Assert.True(sut.InitializeSdk);
         Assert.Equal(_fixture.MinimumEventLevel, sut.MinimumEventLevel);
         Assert.Equal(_fixture.MinimumBreadcrumbLevel, sut.MinimumBreadcrumbLevel);