Added event id and trace to diagnostic summary log

Author: bhazen

identity-server/src/IdentityServer/Events/Infrastructure/EventIds.cs

@@ -69,4 +69,11 @@ public static class EventIds
 
     public const int BackchannelAuthenticationSuccess = BackchannelAuthenticationEventsStart + 0;
     public const int BackchannelAuthenticationFailure = BackchannelAuthenticationEventsStart + 1;
+
+    //////////////////////////////////////////////////////
+    /// Diagnostics related events
+    //////////////////////////////////////////////////////
+    private const int DiagnosticEventsStart = 7000;
+
+    public const int DiagnosticSummaryLogged = DiagnosticEventsStart + 0;
 }

identity-server/src/IdentityServer/Licensing/V2/Diagnostics/DiagnosticSummary.cs

@@ -29,6 +29,7 @@ public async Task PrintSummary()
 
         var span = bufferWriter.WrittenSpan;
 
+        using var diagnosticActivity = Tracing.DiagnosticsActivitySource.StartActivity("DiagnosticSummary");
         var chunkSize = options.Diagnostics.ChunkSize;
         if (span.Length > chunkSize)
         {
@@ -38,12 +39,12 @@ public async Task PrintSummary()
                 var offset = i * chunkSize;
                 var length = Math.Min(chunkSize, span.Length - offset);
                 var chunk = span.Slice(offset, length);
-                logger.LogInformation("Diagnostic data ({current} of {totalChunks}): {diagnosticData}", i + 1, totalChunks, Encoding.UTF8.GetString(chunk));
+                logger.DiagnosticSummaryLogged(i + 1, totalChunks, Encoding.UTF8.GetString(chunk));
             }
         }
         else
         {
-            logger.LogInformation("Diagnostic data: {diagnosticData}", Encoding.UTF8.GetString(bufferWriter.WrittenSpan));
+            logger.DiagnosticSummaryLogged(1, 1, Encoding.UTF8.GetString(bufferWriter.WrittenSpan));
         }
     }
 }

identity-server/src/IdentityServer/Licensing/V2/Diagnostics/Log.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
+
+using Duende.IdentityServer.Events;
+using Microsoft.Extensions.Logging;
+
+namespace Duende.IdentityServer.Licensing.V2.Diagnostics;
+
+internal static class DiagnosticLogParameters
+{
+    public const string Current = "current";
+    public const string TotalChunks = "totalChunks";
+    public const string DiagnosticData = "diagnosticData";
+}
+
+internal static partial class Log
+{
+    [LoggerMessage(
+        LogLevel.Information,
+        EventId = EventIds.DiagnosticSummaryLogged,
+        EventName = "DiagnosticSummaryLogged",
+        Message =
+            $"Diagnostic data ({{{DiagnosticLogParameters.Current}}} of {{{DiagnosticLogParameters.TotalChunks}}}): {{{DiagnosticLogParameters.DiagnosticData}}}"
+    )]
+    public static partial void DiagnosticSummaryLogged(this ILogger logger, int current, int totalChunks, string diagnosticData);
+}

identity-server/src/Telemetry/Tracing.cs

@@ -48,6 +48,13 @@ public static class Tracing
         TraceNames.Validation,
         ServiceVersion);
 
+    /// <summary>
+    /// Diagnostics ActivitySource
+    /// </summary>
+    public static ActivitySource DiagnosticsActivitySource { get; } = new(
+        TraceNames.Diagnostics,
+        ServiceVersion);
+
     /// <summary>
     /// Service version
     /// </summary>
@@ -79,6 +86,11 @@ public static class TraceNames
         /// Service name for detailed validation traces
         /// </summary>
         public static string Validation => Basic + ".Validation";
+
+        /// <summary>
+        /// Service name for diagnostics traces
+        /// </summary>
+        public static string Diagnostics => Basic + ".Diagnostics";
     }
 
     public static class Properties

identity-server/test/IdentityServer.UnitTests/Licensing/v2/DiagnosticSummaryTests.cs

@@ -3,6 +3,7 @@
 
 using System.Text.Json;
 using Duende.IdentityServer.Configuration;
+using Duende.IdentityServer.Events;
 using Duende.IdentityServer.Licensing.V2.Diagnostics;
 using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Logging.Testing;
@@ -84,6 +85,20 @@ public async Task PrintSummary_ShouldCreateChunksWithMaxSizeEightKB()
         }
     }
 
+    [Fact]
+    public async Task PrintSummary_ShouldIncludeLogEventId()
+    {
+        var options = new IdentityServerOptions();
+        var logger = new FakeLogger<DiagnosticSummary>();
+        var diagnosticEntry = new LongDiagnosticEntry { OutputLength = 100000 };
+        var summary = new DiagnosticSummary([diagnosticEntry], options, logger);
+
+        await summary.PrintSummary();
+
+        var logSnapshot = logger.Collector.GetSnapshot();
+        logSnapshot.Count.ShouldBeGreaterThan(0);
+        logSnapshot[0].Id.Id.ShouldBe(EventIds.DiagnosticSummaryLogged);
+    }
 
     private class TestDiagnosticEntry : IDiagnosticEntry
     {