feat: Add support for case-insensitive property name lookups in telemetry converters

Author: hangy

README.md

@@ -153,10 +153,10 @@ By default, trace telemetry submits:
 - **rendered message** in trace's standard *message* property.
 - **severity** in trace's standard *severityLevel* property.
 - **timestamp** in trace's standard *timestamp* property.
-- **operation id** from `operationId` property, or the `LogEvent.TraceId` property.
+- **operation id** from `OperationId` property, or the `LogEvent.TraceId` property.
 - **operation parent id** from `ParentSpanId` property.
 - **operation name** from `OperationName` property.
-- **component version** from `version` property.
+- **component version** from `Version` property.
 - **messageTemplate** in *customDimensions*.
 - **custom log properties** as *customDimensions*.
 
@@ -165,21 +165,21 @@ Event telemetry submits:
 - **message template** as *event name*.
 - **renderedMessage** in *customDimensions*.
 - **timestamp** in event's standard *timestamp* property.
-- **operation id** from `operationId` property, or the `LogEvent.TraceId` property.
+- **operation id** from `OperationId` property, or the `LogEvent.TraceId` property.
 - **operation parent id** from `ParentSpanId` property.
 - **operation name** from `OperationName` property.
-- **component version** from `version` property.
+- **component version** from `Version` property.
 - **custom log properties** as *customDimensions*.
 
 Exception telemetry submits:
 
 - **exception** as standard AI exception.
 - **severity** in trace's standard *severityLevel* property.
 - **timestamp** in trace's standard *timestamp* property.
-- **operation id** from `operationId` property, or the `LogEvent.TraceId` property.
+- **operation id** from `OperationId` property, or the `LogEvent.TraceId` property.
 - **operation parent id** from `ParentSpanId` property.
 - **operation name** from `OperationName` property.
-- **component version** from `version` property.
+- **component version** from `Version` property.
 - **custom log properties** as *customDimensions*.
 
 > Note that **log context** properties are also included in *customDimensions* when Serilog is configured
@@ -356,7 +356,7 @@ System.Threading.Thread.Sleep(1000);
 
 Application Insight's operation id is set from the following sources in order of precedence:
 
-1. `operationId` LogEvent property
+1. `OperationId` LogEvent property
 2. `TraceId` LogEvent property
 
 This can be set like so:
@@ -377,7 +377,7 @@ public class OperationIdEnricher : ILogEventEnricher
 
 ## Including Version
 
-Application Insight supports component version and is pushed out if you set `version` log event property. If it's
+Application Insight supports component version and is pushed out if you set `Version` log event property. If it's
 present, AI's operation version will include the value from this property.
 
 ## Using with SerilogTracing
@@ -392,12 +392,12 @@ The following `LogEvent` properties are mapped to Application Insights telemetry
 | `SpanId` | `Id` (for Request/Dependency telemetry) | From SpanId captured in LogEvent |
 | `ParentSpanId` | `Context.Operation.ParentId` | |
 | `OperationName` | `Context.Operation.Name` | |
-| `operationId` | `Context.Operation.Id` | Overrides TraceId |
-| `version` | `Context.Component.Version` | |
+| `OperationId` | `Context.Operation.Id` | Overrides TraceId |
+| `Version` | `Context.Component.Version` | |
 
 If present, `Baggage` is forwarded to Application Insights custom dimensions (`telemetry.Properties`).
 
-Precedence for `Context.Operation.Id`: `operationId` property > `TraceId` property (when both `operationId` and `TraceId` properties are absent).
+Precedence for `Context.Operation.Id`: `OperationId` property > `TraceId` property (when both `OperationId` and `TraceId` properties are absent).
 
 ### Enriching from `Activity` (explicit opt-in)
 

src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/TelemetryConverters/EventTelemetryConverter.cs

@@ -10,23 +10,25 @@ namespace Serilog.Sinks.ApplicationInsights.TelemetryConverters;
 
 public class EventTelemetryConverter : TelemetryConverterBase
 {
-    /// <inheritdoc cref="EventTelemetryConverter(bool, bool, bool, bool)"/>
+    /// <inheritdoc cref="EventTelemetryConverter(bool, bool, bool, bool, bool)"/>
     public EventTelemetryConverter()
-        : this(false, false, false, false)
+        : this(false, false, false, false, true)
     {
     }
 
-    /// <inheritdoc cref="TelemetryConverterBase(bool, bool, bool, bool)"/>
+    /// <inheritdoc cref="TelemetryConverterBase(bool, bool, bool, bool, bool)"/>
     public EventTelemetryConverter(
         bool includeOperationIdPropertyAsTelemetryProperty,
         bool includeParentSpanIdPropertyAsTelemetryProperty,
         bool includeOperationNamePropertyAsTelemetryProperty,
-        bool includeVersionPropertyAsTelemetryProperty)
+        bool includeVersionPropertyAsTelemetryProperty,
+        bool ignorePropertyNameCase)
                : base(
             includeOperationIdPropertyAsTelemetryProperty,
             includeParentSpanIdPropertyAsTelemetryProperty,
             includeOperationNamePropertyAsTelemetryProperty,
-            includeVersionPropertyAsTelemetryProperty)
+            includeVersionPropertyAsTelemetryProperty,
+            ignorePropertyNameCase)
     {
     }
 

src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/TelemetryConverters/TelemetryConverterBase.cs

@@ -61,13 +61,14 @@ public abstract class TelemetryConverterBase : ITelemetryConverter
     readonly bool _includeParentSpanIdPropertyAsTelemetryProperty;
     readonly bool _includeOperationNamePropertyAsTelemetryProperty;
     readonly bool _includeVersionPropertyAsTelemetryProperty;
+    readonly bool _ignorePropertyNameCase;
 
     /// <summary>
     ///     Creates an instance of <see cref="TelemetryConverterBase" /> using default value formatter (
     ///     <see cref="ApplicationInsightsJsonValueFormatter" />).
     /// </summary>
     public TelemetryConverterBase()
-        : this(false, false, false, false)
+        : this(false, false, false, false, true)
     {
     }
 
@@ -91,18 +92,29 @@ public TelemetryConverterBase()
     ///   if set to <c>true</c> the <see cref="VersionProperty" /> is added to the
     ///   telemetry properties. Otherwise it is only set as <c>ITelemetry.Context.Component.Version</c>.
     /// </param>
+    /// <param name="ignorePropertyNameCase">
+    /// <para>
+    ///   if set to <c>true</c> property name lookups are case insensitive.
+    /// </para>
+    /// <para>
+    ///   The main use case set it to <c>true</c> for maximum compatibility with various logging frameworks
+    ///   but it has a performance impact when there are many properties on the <see cref="LogEvent" />.
+    /// </para>
+    /// </param>
     public TelemetryConverterBase(
         bool includeOperationIdPropertyAsTelemetryProperty,
         bool includeParentSpanIdPropertyAsTelemetryProperty,
         bool includeOperationNamePropertyAsTelemetryProperty,
-        bool includeVersionPropertyAsTelemetryProperty)
+        bool includeVersionPropertyAsTelemetryProperty,
+        bool ignorePropertyNameCase)
     {
         ValueFormatter = new ApplicationInsightsJsonValueFormatter();
 
         _includeOperationIdPropertyAsTelemetryProperty = includeOperationIdPropertyAsTelemetryProperty;
         _includeParentSpanIdPropertyAsTelemetryProperty = includeParentSpanIdPropertyAsTelemetryProperty;
         _includeOperationNamePropertyAsTelemetryProperty = includeOperationNamePropertyAsTelemetryProperty;
         _includeVersionPropertyAsTelemetryProperty = includeVersionPropertyAsTelemetryProperty;
+        _ignorePropertyNameCase = ignorePropertyNameCase;
     }
 
 #pragma warning disable CS1591
@@ -193,33 +205,27 @@ public void ForwardPropertiesToTelemetryProperties(LogEvent logEvent,
             telemetryProperties.Properties.Add(TelemetryPropertiesMessageTemplate, logEvent.MessageTemplate.Text);
 
         if (telemetryProperties is ITelemetry telemetry)
-        {
             PopulateTelemetryFromLogEvent(logEvent, telemetry);
 
-            if (telemetry.Context?.Component != null
-                && logEvent.Properties.TryGetValue(VersionProperty, out var version))
-                telemetry.Context.Component.Version = version.ToString().Trim('\"');
-        }
-
         var baggageWasForwarded = ForwardActivityBaggage(logEvent, telemetryProperties, formatProvider);
         ForwardSimpleProperties(logEvent, telemetryProperties, baggageWasForwarded);
     }
 
-    private static void PopulateTelemetryFromLogEvent(LogEvent logEvent, ITelemetry telemetry)
+    private void PopulateTelemetryFromLogEvent(LogEvent logEvent, ITelemetry telemetry)
     {
         // Operation.Id (TraceId)
-        if (TrySetOperationIdFromLogEvent(logEvent, telemetry, out var operationId))
+        if (TryGetOperationIdFromLogEvent(logEvent, out var operationId))
             telemetry.Context.Operation.Id = operationId;
         else if (logEvent.TraceId is ActivityTraceId traceId)
             telemetry.Context.Operation.Id = traceId.ToHexString();
 
         // Operation.ParentId (ParentSpanId)
-        if (logEvent.Properties.TryGetValue(ParentSpanIdProperty, out var parentSpanIdProp))
-            telemetry.Context.Operation.ParentId = parentSpanIdProp.ToString().Trim('"');
+        if (TryGetParentSpanIdFromLogEvent(logEvent, out var parentSpanId))
+            telemetry.Context.Operation.ParentId = parentSpanId;
 
         // Operation.Name (OperationName)
-        if (logEvent.Properties.TryGetValue(OperationNameProperty, out var operationNameProp))
-            telemetry.Context.Operation.Name = operationNameProp.ToString().Trim('"');
+        if (TryGetOperationNameFromLogEvent(logEvent, out var operationName))
+            telemetry.Context.Operation.Name = operationName;
 
         // Set Id for RequestTelemetry and DependencyTelemetry
         if (logEvent.SpanId is ActivitySpanId spanId)
@@ -229,31 +235,51 @@ private static void PopulateTelemetryFromLogEvent(LogEvent logEvent, ITelemetry
             else if (telemetry is DependencyTelemetry dep)
                 dep.Id = spanId.ToHexString();
         }
+
+        if (telemetry.Context?.Component != null
+            && TryGetVersionFromLogEvent(logEvent, out var version))
+            telemetry.Context.Component.Version = version;
     }
 
-    private static bool TrySetOperationIdFromLogEvent(LogEvent logEvent, ITelemetry telemetry, out string operationId)
+    private bool TryGetOperationIdFromLogEvent(LogEvent logEvent, out string operationId)
+        => TryGetPropertyFromLogEventIgnoreCase(logEvent, OperationIdProperty, out operationId);
+
+    private bool TryGetParentSpanIdFromLogEvent(LogEvent logEvent, out string operationId)
+            => TryGetPropertyFromLogEventIgnoreCase(logEvent, ParentSpanIdProperty, out operationId);
+
+    private bool TryGetOperationNameFromLogEvent(LogEvent logEvent, out string operationId)
+    => TryGetPropertyFromLogEventIgnoreCase(logEvent, OperationNameProperty, out operationId);
+
+    private bool TryGetVersionFromLogEvent(LogEvent logEvent, out string version)
+        => TryGetPropertyFromLogEventIgnoreCase(logEvent, VersionProperty, out version);
+
+    private bool TryGetPropertyFromLogEventIgnoreCase(LogEvent logEvent, string propertyName, out string value)
     {
-        operationId = null;
-        if (logEvent.Properties.TryGetValue(OperationIdProperty, out var operationIdProp))
+        value = null;
+        if (_ignorePropertyNameCase)
+        {
+            value = logEvent.Properties
+                            .FirstOrDefault(p => string.Equals(p.Key, propertyName, StringComparison.OrdinalIgnoreCase))
+                            .Value?
+                            .ToString();
+        }
+        else if (logEvent.Properties.TryGetValue(propertyName, out var operationIdProp))
         {
-            operationId = operationIdProp.ToString();
+            value = operationIdProp.ToString();
         }
         else
         {
-            operationId = logEvent.Properties
-                            .FirstOrDefault(p => string.Equals(p.Key, OperationIdProperty, StringComparison.OrdinalIgnoreCase))
-                            .Value?
-                            .ToString();
+            return false;
         }
 
-        if (string.IsNullOrEmpty(operationId))
+        if (string.IsNullOrEmpty(value))
             return false;
 
-        operationId = operationId.Trim('\"');
+        value = value.Trim('\"');
         return true;
     }
 
-    private static bool ForwardActivityBaggage(LogEvent logEvent, ISupportProperties telemetryProperties, IFormatProvider formatProvider)
+    private bool ForwardActivityBaggage(LogEvent logEvent, ISupportProperties telemetryProperties, IFormatProvider formatProvider)
     {
         if (!logEvent.Properties.TryGetValue(BaggageProperty, out var baggageProp)
             || baggageProp is not StructureValue baggageStructure)
@@ -282,15 +308,16 @@ private void ForwardSimpleProperties(LogEvent logEvent, ISupportProperties telem
         var skipParentSpanId = !_includeParentSpanIdPropertyAsTelemetryProperty;
         var skipOperationName = !_includeOperationNamePropertyAsTelemetryProperty;
         var skipVersion = !_includeVersionPropertyAsTelemetryProperty;
+        var stringComparison = _ignorePropertyNameCase ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal;
 
         foreach (var property in logEvent.Properties)
         {
             if (property.Value is null) continue;
-            if (skipOperationId && OperationIdProperty.Equals(property.Key, StringComparison.Ordinal)) continue;
-            if (skipParentSpanId && ParentSpanIdProperty.Equals(property.Key, StringComparison.Ordinal)) continue;
-            if (skipOperationName && OperationNameProperty.Equals(property.Key, StringComparison.Ordinal)) continue;
-            if (skipVersion && VersionProperty.Equals(property.Key, StringComparison.Ordinal)) continue;
-            if (skipBaggage && BaggageProperty.Equals(property.Key, StringComparison.Ordinal)) continue;
+            if (skipOperationId && OperationIdProperty.Equals(property.Key, stringComparison)) continue;
+            if (skipParentSpanId && ParentSpanIdProperty.Equals(property.Key, stringComparison)) continue;
+            if (skipOperationName && OperationNameProperty.Equals(property.Key, stringComparison)) continue;
+            if (skipVersion && VersionProperty.Equals(property.Key, stringComparison)) continue;
+            if (skipBaggage && BaggageProperty.Equals(property.Key, stringComparison)) continue;
             if (telemetryProperties.Properties.ContainsKey(property.Key)) continue;
 
             ValueFormatter.Format(property.Key, property.Value, telemetryProperties.Properties);

src/Serilog.Sinks.ApplicationInsights/Sinks/ApplicationInsights/TelemetryConverters/TraceTelemetryConverter.cs

@@ -14,23 +14,25 @@ public class TraceTelemetryConverter : TelemetryConverterBase
 {
     static readonly MessageTemplateTextFormatter MessageTemplateTextFormatter = new("{Message:lj}");
 
-    /// <inheritdoc cref="EventTelemetryConverter(bool, bool, bool, bool)"/>
+    /// <inheritdoc cref="EventTelemetryConverter(bool, bool, bool, bool, bool)"/>
     public TraceTelemetryConverter()
-        : this(false, false, false, false)
+        : this(false, false, false, false, true)
     {
     }
 
-    /// <inheritdoc cref="TelemetryConverterBase(bool, bool, bool, bool)"/>
+    /// <inheritdoc cref="TelemetryConverterBase(bool, bool, bool, bool, bool)"/>
     public TraceTelemetryConverter(
         bool includeOperationIdPropertyAsTelemetryProperty,
         bool includeParentSpanIdPropertyAsTelemetryProperty,
         bool includeOperationNamePropertyAsTelemetryProperty,
-        bool includeVersionPropertyAsTelemetryProperty)
+        bool includeVersionPropertyAsTelemetryProperty,
+        bool ignorePropertyNameCase)
         : base(
             includeOperationIdPropertyAsTelemetryProperty,
             includeParentSpanIdPropertyAsTelemetryProperty,
             includeOperationNamePropertyAsTelemetryProperty,
-            includeVersionPropertyAsTelemetryProperty)
+            includeVersionPropertyAsTelemetryProperty,
+            ignorePropertyNameCase)
     {
     }
 

test/Serilog.Sinks.ApplicationInsights.Tests/TelemetryConverters/Event/IncludeOperationIdTest.cs

@@ -6,7 +6,7 @@ namespace Serilog.Sinks.ApplicationInsights.Tests.TelemetryConverters.Event;
 public class IncludeOperationIdTest : ApplicationInsightsTest
 {
     public IncludeOperationIdTest()
-        : base(new EventTelemetryConverter(true, false, false, false), true, true)
+        : base(new EventTelemetryConverter(true, false, false, false, true), true, true)
     {
     }
 

test/Serilog.Sinks.ApplicationInsights.Tests/TelemetryConverters/Event/IncludeOperationNameTest.cs

@@ -6,18 +6,20 @@ namespace Serilog.Sinks.ApplicationInsights.Tests.TelemetryConverters.Event;
 public class IncludeOperationNameTest : ApplicationInsightsTest
 {
     public IncludeOperationNameTest()
-        : base(new EventTelemetryConverter(false, false, true, false), true, true)
+        : base(new EventTelemetryConverter(false, false, true, false, true), true, true)
     {
     }
 
-    [Fact]
-    public void OperationIdIsSetAsTraceProperty()
+    [Theory]
+    [InlineData("Hello, {operationName}!", "operationName", "foo-operation-name")]
+    [InlineData("Hello, {OperationName}!", "OperationName", "bar-operation-name")]
+    public void OperationIdIsSetAsTraceProperty(string pattern, string operationNameKey, string expectedOperationName)
     {
         using var activity = new System.Diagnostics.Activity("TestActivity");
         activity.Start();
 
-        Logger.Information("Hello, {OperationName}!", "foo-operation-name");
+        Logger.Information(pattern, expectedOperationName);
 
-        Assert.Equal("foo-operation-name", LastSubmittedEventTelemetry.Properties["OperationName"]);
+        Assert.Equal(expectedOperationName, LastSubmittedEventTelemetry.Properties[operationNameKey]);
     }
 }

test/Serilog.Sinks.ApplicationInsights.Tests/TelemetryConverters/Event/IncludeParentSpanIdTest.cs

@@ -6,18 +6,20 @@ namespace Serilog.Sinks.ApplicationInsights.Tests.TelemetryConverters.Event;
 public class IncludeSpanIdTest : ApplicationInsightsTest
 {
     public IncludeSpanIdTest()
-        : base(new EventTelemetryConverter(false, true, false, false), true, true)
+        : base(new EventTelemetryConverter(false, true, false, false, true), true, true)
     {
     }
 
-    [Fact]
-    public void OperationIdIsSetAsTraceProperty()
+    [Theory]
+    [InlineData("Hello, {parentSpanId}!", "parentSpanId", "foo-parent-span-id")]
+    [InlineData("Hello, {ParentSpanId}!", "ParentSpanId", "bar-parent-span-id")]
+    public void ParentSpanIdIsSetAsTraceProperty(string pattern, string parentSpanIdKey, string expectedParentSpanId)
     {
         using var activity = new System.Diagnostics.Activity("TestActivity");
         activity.Start();
 
-    Logger.Information("Hello, {ParentSpanId}!", "foo-parent-span-id");
+        Logger.Information(pattern, expectedParentSpanId);
 
-        Assert.Equal("foo-parent-span-id", LastSubmittedEventTelemetry.Properties["ParentSpanId"]);
+        Assert.Equal(expectedParentSpanId, LastSubmittedEventTelemetry.Properties[parentSpanIdKey]);
     }
 }

test/Serilog.Sinks.ApplicationInsights.Tests/TelemetryConverters/Event/IncludeVersionTest.cs

@@ -6,18 +6,20 @@ namespace Serilog.Sinks.ApplicationInsights.Tests.TelemetryConverters.Event;
 public class IncludeVersionTest : ApplicationInsightsTest
 {
     public IncludeVersionTest()
-        : base(new EventTelemetryConverter(false, false, false, true), true, true)
+        : base(new EventTelemetryConverter(false, false, false, true, true), true, true)
     {
     }
 
-    [Fact]
-    public void OperationIdIsSetAsTraceProperty()
+    [Theory]
+    [InlineData("Hello, {version}!", "version", "v1.3.3.7")]
+    [InlineData("Hello, {Version}!", "Version", "v4.2.0")]
+    public void VersionSetAsTraceProperty(string pattern, string versionKey, string expectedVersion)
     {
         using var activity = new System.Diagnostics.Activity("TestActivity");
         activity.Start();
 
-        Logger.Information("Hello, {version}!", "v1.3.3.7");
+        Logger.Information(pattern, expectedVersion);
 
-        Assert.Equal("v1.3.3.7", LastSubmittedEventTelemetry.Properties["version"]);
+        Assert.Equal(expectedVersion, LastSubmittedEventTelemetry.Properties[versionKey]);
     }
 }