feat: Consolidate operation name and baggage enrichment into a single ActivityDetailsEnricher

Author: hangy

README.md

@@ -403,17 +403,11 @@ Precedence for `Context.Operation.Id`: `operationId` property > `TraceId` proper
 
 This sink is designed to work well with Serilog's asynchronous/batched processing. To keep telemetry deterministic, adding `OperationName` and `Baggage` from the ambient `Activity` is an explicit opt-in: copy the values onto the `LogEvent` before it reaches the sink.
 
-Two built-in enrichers are included:
-
-- `ActivityOperationNameEnricher` — copies `Activity.OperationName` into the `OperationName` log event property.
-- `ActivityBaggageEnricher` — copies baggage items from the current `Activity` into the `Baggage` log event property as a `StructureValue`.
-
-Enable them using the provided `Enrich` extension methods:
+The sink includes an enricher that adds this by default. Enable it using the provided `Enrich` extension method:
 
 ```csharp
 Log.Logger = new LoggerConfiguration()
-    .Enrich.WithOperationName()
-    .Enrich.WithBaggage()
+    .Enrich.WithActivityDetails(includeOperationName: true, includeBaggage: true)
     .WriteTo.ApplicationInsights(telemetryConfiguration, TelemetryConverter.Traces)
     .CreateLogger();
 ```
@@ -422,7 +416,7 @@ Log.Logger = new LoggerConfiguration()
 
 This is a new major release (5.0). Notable changes:
 
-- **OperationName and Baggage are opt-in:** they are only forwarded when present as `LogEvent` properties (use the built-in enrichers above or your own enricher).
+- **OperationName and Baggage are opt-in:** they are only forwarded when present as `LogEvent` properties (use the built-in enricher above or your own enricher).
 - **Less redundancy in custom dimensions by default:** operation-related values are set on `ITelemetry.Context` and are not duplicated into `telemetry.Properties` unless enabled.
 
 ### `TelemetryConverterBase` constructor flags

src/Serilog.Sinks.ApplicationInsights/LoggerEnrichmentConfigurationExtensions.cs

@@ -15,17 +15,10 @@ public static class LoggerEnrichmentConfigurationExtensions
     extension(LoggerEnrichmentConfiguration loggerEnrichmentConfiguration)
     {
         /// <summary>
-        ///     Enriches log events with the operation name from <see cref="Activity" />.
+        ///     Enriches log events with details from <see cref="Activity" />.
         /// </summary>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
-        public LoggerConfiguration WithOperationName()
-            => loggerEnrichmentConfiguration.With<ActivityOperationNameEnricher>();
-
-        /// <summary>
-        ///     Enriches log events with the baggage from <see cref="Activity" />.
-        /// </summary>
-        /// <returns>Logger configuration, allowing configuration to continue.</returns>
-        public LoggerConfiguration WithBaggage()
-            => loggerEnrichmentConfiguration.With<ActivityBaggageEnricher>();
+        public LoggerConfiguration WithActivityDetails(bool includeOperationName = true, bool includeBaggage = true)
+            => loggerEnrichmentConfiguration.With(new ActivityDetailsEnricher(includeOperationName, includeBaggage));
     }
 }

…hts/Enrichers/ActivityBaggageEnricher.cs …hts/Enrichers/ActivityDetailsEnricher.cssrc/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/Enrichers/ActivityBaggageEnricher.cs renamed to src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/Enrichers/ActivityDetailsEnricher.cs src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/Enrichers/ActivityBaggageEnricher.cs renamed to src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/Enrichers/ActivityDetailsEnricher.cs

@@ -9,10 +9,13 @@
 namespace Serilog.Sinks.ApplicationInsights.Enrichers;
 
 /// <summary>
-/// Enriches log events with the baggage from <see cref="Activity"/>.
+/// Enriches log events with details from <see cref="Activity"/>.
 /// </summary>
-public class ActivityBaggageEnricher : ILogEventEnricher
+public class ActivityDetailsEnricher(bool includeOperationName, bool includeBaggage) : ILogEventEnricher
 {
+    readonly bool _includeOperationName = includeOperationName;
+    readonly bool _includeBaggage = includeBaggage;
+
     /// <inheritdoc/>
     public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
     {
@@ -26,7 +29,34 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
             throw new ArgumentNullException(nameof(propertyFactory));
         }
 
-        if (Activity.Current is not {} activity)
+        if (Activity.Current is not { } activity)
+        {
+            return;
+        }
+
+        EnrichOperationName(logEvent, propertyFactory, activity);
+        EnrichBaggage(logEvent, propertyFactory, activity);
+    }
+
+    private void EnrichOperationName(LogEvent logEvent, ILogEventPropertyFactory propertyFactory, Activity activity)
+    {
+        if (!_includeOperationName)
+        {
+            return;
+        }
+
+        if (activity.OperationName is not string operationName)
+        {
+            return;
+        }
+
+        LogEventProperty operationNameProperty = propertyFactory.CreateProperty(TelemetryConverterBase.OperationNameProperty, operationName);
+        logEvent.AddPropertyIfAbsent(operationNameProperty);
+    }
+
+    private void EnrichBaggage(LogEvent logEvent, ILogEventPropertyFactory propertyFactory, Activity activity)
+    {
+        if (!_includeBaggage)
         {
             return;
         }

src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/Enrichers/ActivityOperationNameEnricher.cs

@@ -20,16 +20,7 @@ protected ApplicationInsightsTest(ITelemetryConverter converter = null, bool add
             .MinimumLevel.Debug()
             .Enrich.FromLogContext();
 
-        if (addOperationNameEnricher)
-        {
-            loggerConfiguration = loggerConfiguration.Enrich.WithOperationName();
-        }
-
-        if (addBaggageEnricher)
-        {
-            loggerConfiguration = loggerConfiguration.Enrich.WithBaggage();
-        }
-
+        loggerConfiguration = loggerConfiguration.Enrich.WithActivityDetails(addOperationNameEnricher, addBaggageEnricher);
         Logger = loggerConfiguration.CreateLogger();
     }
 

test/Serilog.Sinks.ApplicationInsights.Tests/ApplicationInsightsTest.cs

@@ -8,12 +8,47 @@
 
 namespace Serilog.Sinks.ApplicationInsights.Tests.Enrichers;
 
-public class ActivityBaggageEnricherTests
+public class ActivityDetailsEnricherTests
 {
     [Fact]
-    public void Single_baggage_value_is_enriched()
+    public void Operation_name_is_enriched_if_enabled()
     {
-        ActivityBaggageEnricher enricher = new();
+        ActivityDetailsEnricher enricher = new(includeOperationName: true, includeBaggage: false);
+        string operationName = Guid.NewGuid().ToString("N");
+        using Activity activity = new(operationName);
+        activity.Start();
+        LogEvent logEvent = new(DateTimeOffset.Now, LogEventLevel.Information, null, MessageTemplate.Empty, []);
+
+        enricher.Enrich(logEvent, TestLogEventPropertyFactory.Instance);
+
+        bool hasProperty = logEvent.Properties.TryGetValue("OperationName", out LogEventPropertyValue property);
+        Assert.True(hasProperty);
+        Assert.NotNull(property);
+        Assert.IsType<ScalarValue>(property);
+        ScalarValue scalarValue = (ScalarValue)property;
+        Assert.Equal(operationName, scalarValue.Value);
+    }
+
+    [Fact]
+    public void Operation_name_is_not_enriched_if_disabled()
+    {
+        ActivityDetailsEnricher enricher = new(includeOperationName: false, includeBaggage: false);
+        string operationName = Guid.NewGuid().ToString("N");
+        using Activity activity = new(operationName);
+        activity.Start();
+        LogEvent logEvent = new(DateTimeOffset.Now, LogEventLevel.Information, null, MessageTemplate.Empty, []);
+
+        enricher.Enrich(logEvent, TestLogEventPropertyFactory.Instance);
+
+        bool hasProperty = logEvent.Properties.TryGetValue("OperationName", out LogEventPropertyValue property);
+        Assert.False(hasProperty);
+        Assert.Null(property);
+    }
+
+    [Fact]
+    public void Single_baggage_value_is_not_enriched_if_disabled()
+    {
+        ActivityDetailsEnricher enricher = new(includeOperationName: false, includeBaggage: false);
         using Activity activity = new("TestActivity");
         string baggageName = Guid.NewGuid().ToString("N");
         string baggageValue = Guid.NewGuid().ToString("N");
@@ -24,25 +59,17 @@ public void Single_baggage_value_is_enriched()
         enricher.Enrich(logEvent, TestLogEventPropertyFactory.Instance);
 
         bool hasProperty = logEvent.Properties.TryGetValue("Baggage", out LogEventPropertyValue property);
-        Assert.True(hasProperty);
-        Assert.NotNull(property);
-        Assert.IsType<StructureValue>(property);
-        StructureValue scalarValue = (StructureValue)property;
-        Assert.Single(scalarValue.Properties);
-        LogEventProperty valueProperty = scalarValue.Properties[0];
-        Assert.Equal(baggageName, valueProperty.Name);
-        Assert.IsType<ScalarValue>(valueProperty.Value);
-        ScalarValue scalarValueInner = (ScalarValue)valueProperty.Value;
-        Assert.Equal(baggageValue, scalarValueInner.Value);
+        Assert.False(hasProperty);
+        Assert.Null(property);
     }
 
     [Fact]
-    public void Multiple_baggage_values_are_enriched()
+    public void Multiple_baggage_values_are_enriched_if_enabled()
     {
         Random random = new();
         Dictionary<string, string> baggageItems = GenerateRandomBaggageItems(10);
 
-        ActivityBaggageEnricher enricher = new();
+        ActivityDetailsEnricher enricher = new(includeOperationName: false, includeBaggage: true);
         using Activity activity = new("TestActivity");
         foreach (var item in baggageItems)
         {