feat: introduce EntityLoggingScope to support scopes as key-value pairs inside custom properties of application insights (#893)

Author: kimpenhaus

src/KubeOps.Operator/Logging/EntityLoggingScope.cs

@@ -0,0 +1,43 @@
+using System.Collections;
+
+using k8s;
+using k8s.Models;
+
+namespace KubeOps.Operator.Logging;
+
+#pragma warning disable CA1710
+internal sealed record EntityLoggingScope : IReadOnlyCollection<KeyValuePair<string, object>>
+#pragma warning restore CA1710
+{
+    private EntityLoggingScope(IReadOnlyDictionary<string, object> state)
+    {
+        Values = state;
+    }
+
+    public int Count => Values.Count;
+
+    private string? CachedFormattedString { get; set; }
+
+    private IReadOnlyDictionary<string, object> Values { get; }
+
+    public static EntityLoggingScope CreateFor<TEntity>(WatchEventType eventType, TEntity entity)
+        where TEntity : IKubernetesObject<V1ObjectMeta>
+        => new(
+            new Dictionary<string, object>
+            {
+                { "EventType", eventType },
+                { nameof(entity.Kind), entity.Kind },
+                { "Namespace", entity.Namespace() },
+                { "Name", entity.Name() },
+                { "ResourceVersion", entity.ResourceVersion() },
+            });
+
+    public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
+        => Values.GetEnumerator();
+
+    public override string ToString()
+        => CachedFormattedString ??= $"{{ {string.Join(", ", Values.Select(kvp => $"{kvp.Key} = {kvp.Value}"))} }}";
+
+    IEnumerator IEnumerable.GetEnumerator()
+        => GetEnumerator();
+}

src/KubeOps.Operator/Watcher/ResourceWatcher{TEntity}.cs

@@ -11,6 +11,7 @@
 using KubeOps.Abstractions.Entities;
 using KubeOps.Abstractions.Finalizer;
 using KubeOps.KubernetesClient;
+using KubeOps.Operator.Logging;
 using KubeOps.Operator.Queue;
 
 using Microsoft.Extensions.DependencyInjection;
@@ -200,17 +201,7 @@ private async Task WatchClientEventsAsync(CancellationToken stoppingToken)
                                    cancellationToken: stoppingToken))
                 {
 #pragma warning disable SA1312
-                    using var _ = logger.BeginScope(new
-#pragma warning restore SA1312
-                    {
-                        EventType = type,
-
-                        // ReSharper disable once RedundantAnonymousTypePropertyName
-                        Kind = entity.Kind,
-                        Namespace = entity.Namespace(),
-                        Name = entity.Name(),
-                        ResourceVersion = entity.ResourceVersion(),
-                    });
+                    using var _ = logger.BeginScope(EntityLoggingScope.CreateFor(type, entity));
                     logger.LogInformation(
                         """Received watch event "{EventType}" for "{Kind}/{Name}", last observed resource version: {ResourceVersion}.""",
                         type,