Match the signature of OpenTelemetry.SuppressInstrumentationScope.Begin() to keep configuration uncluttered

Author: nblumhardt

src/Serilog.Sinks.OpenTelemetry/OpenTelemetryLoggerConfigurationExtensions.cs

@@ -43,7 +43,7 @@ public static class OpenTelemetryLoggerConfigurationExtensions
     /// Send log events to an OTLP exporter.
     /// </summary>
     /// <param name="loggerSinkConfiguration">
-    /// The `WriteTo` configuration object.
+    /// The <c>WriteTo</c> configuration object.
     /// </param>
     /// <param name="configure">The configuration callback.</param>
     /// <param name="ignoreEnvironment">If false the configuration will be overridden with values
@@ -70,7 +70,9 @@ public static LoggerConfiguration OpenTelemetry(
             protocol: options.Protocol,
             headers: new Dictionary<string, string>(options.Headers),
             httpMessageHandler: options.HttpMessageHandler ?? CreateDefaultHttpMessageHandler(),
-            onBeginSuppressInstrumentation: options.OnBeginSuppressInstrumentation);
+            onBeginSuppressInstrumentation: options.OnBeginSuppressInstrumentation != null ?
+                () => options.OnBeginSuppressInstrumentation(true)
+                : null);
 
         ILogEventSink? logsSink = null, tracesSink = null;
 
@@ -104,7 +106,7 @@ public static LoggerConfiguration OpenTelemetry(
     /// Send log events to an OTLP exporter.
     /// </summary>
     /// <param name="loggerSinkConfiguration">
-    /// The `WriteTo` configuration object.
+    /// The <c>WriteTo</c> configuration object.
     /// </param>
     /// <param name="endpoint">
     /// The full URL of the OTLP exporter endpoint.
@@ -157,7 +159,7 @@ public static LoggerConfiguration OpenTelemetry(
     /// Audit to an OTLP exporter, waiting for each event to be acknowledged, and propagating errors to the caller.
     /// </summary>
     /// <param name="loggerAuditSinkConfiguration">
-    /// The `AuditTo` configuration object.
+    /// The <c>AuditTo</c> configuration object.
     /// </param>
     /// <param name="configure">The configuration callback.</param>
     public static LoggerConfiguration OpenTelemetry(
@@ -175,7 +177,9 @@ public static LoggerConfiguration OpenTelemetry(
             protocol: options.Protocol,
             headers: new Dictionary<string, string>(options.Headers),
             httpMessageHandler: options.HttpMessageHandler ?? CreateDefaultHttpMessageHandler(),
-            onBeginSuppressInstrumentation: options.OnBeginSuppressInstrumentation);
+            onBeginSuppressInstrumentation: options.OnBeginSuppressInstrumentation != null ?
+                () => options.OnBeginSuppressInstrumentation(true)
+                : null);
 
         ILogEventSink? logsSink = null, tracesSink = null;
 

src/Serilog.Sinks.OpenTelemetry/Sinks/OpenTelemetry/OpenTelemetrySinkOptions.cs

@@ -167,5 +167,7 @@ public string? TracesEndpoint
     /// <example>
     /// options.OnBeginSuppressInstrumentation = OpenTelemetry.SuppressInstrumentationScope.Begin;
     /// </example>
-    public Func<IDisposable>? OnBeginSuppressInstrumentation { get; set; }
+    /// <remarks>This callback accepts a <c langword="bool"/> in order to match the signature of the OpenTelemetry SDK method
+    /// that is typically assigned to it. The sink always provides the callback with the value <c langword="true" />.</remarks>
+    public Func<bool, IDisposable>? OnBeginSuppressInstrumentation { get; set; }
 }