Merge pull request #242 from serilog-contrib/dev

5.0.0 Release

Author: nblumhardt

.editorconfig

@@ -49,3 +49,6 @@ csharp_space_around_declaration_statements = false
 csharp_space_before_open_square_brackets = false
 csharp_space_between_empty_square_brackets = false
 csharp_space_between_square_brackets = false
+
+# C# code style - Accessibility modifiers
+dotnet_style_require_accessibility_modifiers = omit_if_default

.github/workflows/ci.yml

@@ -22,9 +22,9 @@ jobs:
       contents: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Setup
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
       - name: Compute build number

Directory.Version.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <VersionPrefix>4.1.0</VersionPrefix>
+    <VersionPrefix>5.0.0</VersionPrefix>
   </PropertyGroup>
 </Project>

README.md

@@ -1,8 +1,7 @@
 {
     "sdk": {
-      "version": "9.0.100",
+      "version": "10.0.100",
       "allowPrerelease": false,
       "rollForward": "latestFeature"
     }
   }
-  

global.json

@@ -1,11 +1,11 @@
 // Copyright 2016 Serilog Contributors
-// 
+//
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-// 
+//
 //     http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -49,8 +49,7 @@ public static LoggerConfiguration ApplicationInsights(
         var client = new TelemetryClient(telemetryConfiguration ?? TelemetryConfiguration.Active);
 #pragma warning restore CS0618
 
-        return loggerConfiguration.Sink(new ApplicationInsightsSink(client, telemetryConverter),
-            restrictedToMinimumLevel, levelSwitch);
+        return loggerConfiguration.ApplicationInsights(client, telemetryConverter, restrictedToMinimumLevel, levelSwitch);
     }
 
     /// <summary>
@@ -72,8 +71,7 @@ public static LoggerConfiguration ApplicationInsights(
         var client = new TelemetryClient(TelemetryConfiguration.Active);
 #pragma warning restore CS0618
 
-        return loggerConfiguration.Sink(new ApplicationInsightsSink(client, telemetryConverter),
-            restrictedToMinimumLevel, levelSwitch);
+        return loggerConfiguration.ApplicationInsights(client, telemetryConverter, restrictedToMinimumLevel, levelSwitch);
     }
 
     /// <summary>
@@ -93,11 +91,9 @@ public static LoggerConfiguration ApplicationInsights(
         LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
         LoggingLevelSwitch levelSwitch = null)
     {
-        return loggerConfiguration.Sink(new ApplicationInsightsSink(telemetryClient, telemetryConverter),
-            restrictedToMinimumLevel, levelSwitch);
+        return loggerConfiguration.Sink(new ApplicationInsightsSink(telemetryClient, telemetryConverter), restrictedToMinimumLevel, levelSwitch);
     }
 
-
     /// <summary>
     ///     Adds a Serilog sink that writes <see cref="LogEvent">log events</see> to Microsoft Application Insights
     ///     using a custom <see cref="ITelemetry" /> converter / constructor. Only use in rare cases when your application
@@ -125,7 +121,6 @@ public static LoggerConfiguration ApplicationInsights(
 
         var client = new TelemetryClient(config);
 
-        return loggerConfiguration.Sink(new ApplicationInsightsSink(client, telemetryConverter),
-            restrictedToMinimumLevel, levelSwitch);
+        return loggerConfiguration.ApplicationInsights(client, telemetryConverter, restrictedToMinimumLevel, levelSwitch);
     }
-}
+}

src/Serilog.Sinks.ApplicationInsights/LoggerConfigurationApplicationInsightsExtensions.cs

@@ -0,0 +1,24 @@
+// SPDX-FileCopyrightText: 2025 Serilog Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Diagnostics;
+using Serilog.Configuration;
+using Serilog.Sinks.ApplicationInsights.Enrichers;
+
+namespace Serilog;
+
+/// <summary>
+///     Provides enrichment extensions to <see cref="LoggerConfiguration" />.
+/// </summary>
+public static class LoggerEnrichmentConfigurationExtensions
+{
+    extension(LoggerEnrichmentConfiguration loggerEnrichmentConfiguration)
+    {
+        /// <summary>
+        ///     Enriches log events with details from <see cref="Activity" />.
+        /// </summary>
+        /// <returns>Logger configuration, allowing configuration to continue.</returns>
+        public LoggerConfiguration WithActivityDetails(bool includeOperationName = true, bool includeBaggage = true)
+            => loggerEnrichmentConfiguration.With(new ActivityDetailsEnricher(includeOperationName, includeBaggage));
+    }
+}

src/Serilog.Sinks.ApplicationInsights/LoggerEnrichmentConfigurationExtensions.cs

@@ -23,7 +23,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Serilog" Version="4.2.0" />
+    <PackageReference Include="Serilog" Version="4.3.0" />
     <PackageReference Include="Microsoft.ApplicationInsights" Version="2.23.0" />
   </ItemGroup>
 

src/Serilog.Sinks.ApplicationInsights/Serilog.Sinks.ApplicationInsights.csproj

@@ -1,22 +1,19 @@
 // Copyright 2016 Serilog Contributors
-// 
+//
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-// 
+//
 //     http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System;
 using System.Reflection;
 using System.Runtime.ExceptionServices;
-using System.Threading;
-using System.Threading.Tasks;
 using Microsoft.ApplicationInsights;
 using Microsoft.ApplicationInsights.Channel;
 using Serilog.Core;
@@ -121,7 +118,7 @@ public virtual void Emit(LogEvent logEvent)
 
     #endregion
 
-    #region AI specifc Helper methods
+    #region AI specific Helper methods
 
     /// <summary>
     ///     Hands over the <paramref name="telemetry" /> to the AI telemetry client.
@@ -139,7 +136,7 @@ protected virtual void TrackTelemetry(ITelemetry telemetry)
         _telemetryClient?.Track(telemetry);
     }
 
-    #endregion AI specifc Helper methods
+    #endregion AI specific Helper methods
 
     #region Implementation of IDisposable
 
@@ -195,7 +192,7 @@ protected virtual void Dispose(bool disposeManagedResources)
             IsDisposing = false;
         }
     }
-    
+
 #if NET6_0_OR_GREATER
     /// <summary>
     /// Disposes the sink and flushes telemetry to App Insights.
@@ -204,7 +201,7 @@ public async ValueTask DisposeAsync()
     {
         if (IsDisposing || IsDisposed)
             return;
-        
+
         try
         {
             IsDisposing = true;
@@ -220,4 +217,4 @@ public async ValueTask DisposeAsync()
 #endif
 
     #endregion Implementation of IDisposable
-}
+}

src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/ApplicationInsightsSink.cs

@@ -0,0 +1,74 @@
+// SPDX-FileCopyrightText: 2025 Serilog Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Diagnostics;
+using Serilog.Core;
+using Serilog.Events;
+using Serilog.Sinks.ApplicationInsights.TelemetryConverters;
+
+namespace Serilog.Sinks.ApplicationInsights.Enrichers;
+
+/// <summary>
+/// Enriches log events with details from <see cref="Activity"/>.
+/// </summary>
+public class ActivityDetailsEnricher(bool includeOperationName, bool includeBaggage) : ILogEventEnricher
+{
+    readonly bool _includeOperationName = includeOperationName;
+    readonly bool _includeBaggage = includeBaggage;
+
+    /// <inheritdoc/>
+    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+    {
+        if (logEvent == null)
+        {
+            throw new ArgumentNullException(nameof(logEvent));
+        }
+
+        if (propertyFactory == null)
+        {
+            throw new ArgumentNullException(nameof(propertyFactory));
+        }
+
+        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;
+        }
+
+        IEnumerable<LogEventProperty> items = activity.Baggage
+            .Where(IsValidBaggageItem)
+            .Select(item => propertyFactory.CreateProperty(item.Key, item.Value));
+
+        LogEventProperty baggageProperty = new(TelemetryConverterBase.BaggageProperty, new StructureValue(items));
+        logEvent.AddPropertyIfAbsent(baggageProperty);
+    }
+
+    private static bool IsValidBaggageItem(KeyValuePair<string, string> item)
+        => !string.IsNullOrEmpty(item.Key) && !string.IsNullOrEmpty(item.Value);
+}