simplify logging using with logger scopes

Author: smdn

examples/Smdn.Net.MuninNode.Hosting/getting-started/Program.cs

@@ -78,7 +78,10 @@ static async Task Main(string[] args)
         )
         // Add other services.
         .AddLogging(builder => builder
-          .AddSimpleConsole(static options => options.SingleLine = true)
+          .AddSimpleConsole(static options => {
+            options.SingleLine = true;
+            options.IncludeScopes = true;
+          })
           .AddFilter(static level => LogLevel.Trace <= level)
         );
 

examples/Smdn.Net.MuninNode/getting-started/Program.cs

@@ -72,7 +72,10 @@ static async Task Main()
       )
       // Add other services.
       .AddLogging(builder => builder
-        .AddSimpleConsole(static options => options.SingleLine = true)
+        .AddSimpleConsole(static options => {
+          options.SingleLine = true;
+          options.IncludeScopes = true;
+        })
         .AddFilter(static level => LogLevel.Trace <= level)
       );
 

examples/Smdn.Net.MuninNode/local-node-uptime/Program.cs

@@ -50,7 +50,10 @@
 
 services.AddLogging(
   builder => builder
-    .AddSimpleConsole(static options => options.SingleLine = true)
+    .AddSimpleConsole(static options => {
+      options.SingleLine = true;
+      options.IncludeScopes = true;
+    })
     .AddFilter(static level => LogLevel.Trace <= level)
 );
 

examples/Smdn.Net.MuninNode/multiple-fields/Program.cs

@@ -40,7 +40,10 @@
 
 services.AddLogging(
   builder => builder
-    .AddSimpleConsole(static options => options.SingleLine = true)
+    .AddSimpleConsole(static options => {
+      options.SingleLine = true;
+      options.IncludeScopes = true;
+    })
     .AddFilter(static level => LogLevel.Trace <= level)
 );
 

src/Smdn.Net.MuninNode/Smdn.Net.MuninNode.Transport/MuninNodeClient.cs

@@ -77,8 +77,8 @@ public async ValueTask<int> ReceiveAsync(IBufferWriter<byte> buffer, Cancellatio
     if (client is null)
       throw new ObjectDisposedException(GetType().FullName);
 
-    // holds a reference to the endpoint before the client being disposed
-    var remoteEndPoint = client.RemoteEndPoint;
+    // begin logger scope with this client's endpoint
+    using var scope = logger?.BeginScope(client.RemoteEndPoint);
 
     const int ReceiveChunkSize = 256;
     var totalByteCount = 0;
@@ -111,19 +111,15 @@ ex.SocketErrorCode is
           SocketError.ConnectionReset // ECONNRESET (104)
       ) {
         logger?.LogDebug(
-          "[{RemoteEndPoint}] expected socket exception ({NumericSocketErrorCode} {SocketErrorCode})",
-          remoteEndPoint,
+          "expected socket exception ({NumericSocketErrorCode} {SocketErrorCode})",
           (int)ex.SocketErrorCode,
           ex.SocketErrorCode
         );
 
         break; // expected exception
       }
       catch (ObjectDisposedException) {
-        logger?.LogDebug(
-          "[{RemoteEndPoint}] socket has been disposed",
-          remoteEndPoint
-        );
+        logger?.LogDebug("socket has been disposed");
 
         break; // expected exception
       }

src/Smdn.Net.MuninNode/Smdn.Net.MuninNode/NodeBase.cs

@@ -293,8 +293,8 @@ public async ValueTask AcceptSingleSessionAsync(
       cancellationToken: cancellationToken
     ).ConfigureAwait(false);
 
-    // holds a reference to the endpoint before the client being disposed
-    var remoteEndPoint = client.EndPoint;
+    // begin logger scope with this client's endpoint
+    using var scope = Logger?.BeginScope(client.EndPoint);
 
     try {
       cancellationToken.ThrowIfCancellationRequested();
@@ -310,7 +310,7 @@ await ProcessSessionAsync(
     finally {
       await client.DisposeAsync().ConfigureAwait(false);
 
-      Logger?.LogInformation("[{RemoteEndPoint}] connection closed", remoteEndPoint);
+      Logger?.LogInformation("connection closed");
     }
 
     bool CanAccept(IMuninNodeClient client)
@@ -326,7 +326,7 @@ bool CanAccept(IMuninNodeClient client)
       }
 
       if (accessRule is not null && !accessRule.IsAcceptable(remoteIPEndPoint)) {
-        Logger?.LogWarning("access refused: {RemoteEndPoint}", remoteIPEndPoint);
+        Logger?.LogWarning("access refused");
 
         return false;
       }
@@ -342,11 +342,9 @@ CancellationToken cancellationToken
   {
     cancellationToken.ThrowIfCancellationRequested();
 
-    // holds a reference to the endpoint before the client being disposed
-    var remoteEndPoint = client.EndPoint;
-    var sessionId = GenerateSessionId(listener!.EndPoint, remoteEndPoint);
+    var sessionId = GenerateSessionId(listener!.EndPoint, client.EndPoint);
 
-    Logger?.LogDebug("[{RemoteEndPoint}] sending banner", remoteEndPoint);
+    Logger?.LogDebug("sending banner");
 
     try {
       await SendResponseAsync(
@@ -356,19 +354,15 @@ await SendResponseAsync(
       ).ConfigureAwait(false);
     }
     catch (MuninNodeClientDisconnectedException) {
-      Logger?.LogWarning(
-        "[{RemoteEndPoint}] client closed session while sending banner",
-        remoteEndPoint
-      );
+      Logger?.LogWarning("client closed session while sending banner");
 
       return;
     }
 #pragma warning disable CA1031
     catch (Exception ex) {
       Logger?.LogCritical(
         ex,
-        "[{RemoteEndPoint}] unexpected exception occured while sending banner",
-        remoteEndPoint
+        "unexpected exception occured while sending banner"
       );
 
       return;
@@ -377,7 +371,10 @@ await SendResponseAsync(
 
     cancellationToken.ThrowIfCancellationRequested();
 
-    Logger?.LogInformation("[{RemoteEndPoint}] session started; ID={SessionId}", remoteEndPoint, sessionId);
+    // begin logger scope with this session id
+    using var scope = Logger?.BeginScope(sessionId);
+
+    Logger?.LogInformation("session started");
 
     try {
       if (PluginProvider.SessionCallback is not null)
@@ -392,11 +389,11 @@ await SendResponseAsync(
       var pipe = new Pipe();
 
       await Task.WhenAll(
-        ReceiveCommandAsync(client, remoteEndPoint, pipe.Writer, cancellationToken),
-        ProcessCommandAsync(client, remoteEndPoint, pipe.Reader, cancellationToken)
+        ReceiveCommandAsync(client, pipe.Writer, cancellationToken),
+        ProcessCommandAsync(client, pipe.Reader, cancellationToken)
       ).ConfigureAwait(false);
 
-      Logger?.LogInformation("[{RemoteEndPoint}] session closed; ID={SessionId}", remoteEndPoint, sessionId);
+      Logger?.LogInformation("session closed");
     }
     finally {
       foreach (var plugin in PluginProvider.Plugins) {
@@ -436,7 +433,6 @@ private static string GenerateSessionId(EndPoint? localEndPoint, EndPoint? remot
 
   private async Task ReceiveCommandAsync(
     IMuninNodeClient client,
-    EndPoint? remoteEndPoint,
     PipeWriter writer,
     CancellationToken cancellationToken
   )
@@ -451,18 +447,14 @@ CancellationToken cancellationToken
           break;
       }
       catch (OperationCanceledException) {
-        Logger?.LogInformation(
-          "[{RemoteEndPoint}] operation canceled",
-          remoteEndPoint
-        );
+        Logger?.LogInformation("operation canceled");
         throw;
       }
 #pragma warning disable CA1031
       catch (Exception ex) {
         Logger?.LogError(
           ex,
-          "[{RemoteEndPoint}] unexpected exception while receiving",
-          remoteEndPoint
+          "unexpected exception while receiving"
         );
         break; // swallow
       }
@@ -481,7 +473,6 @@ CancellationToken cancellationToken
 
   private async Task ProcessCommandAsync(
     IMuninNodeClient client,
-    EndPoint? remoteEndPoint,
     PipeReader reader,
     CancellationToken cancellationToken
   )
@@ -504,25 +495,18 @@ await RespondToCommandAsync(
         }
       }
       catch (MuninNodeClientDisconnectedException) {
-        Logger?.LogInformation(
-          "[{RemoteEndPoint}] client disconnected",
-          remoteEndPoint
-        );
+        Logger?.LogInformation("client disconnected");
         break; // expected exception
       }
       catch (OperationCanceledException) {
-        Logger?.LogInformation(
-          "[{RemoteEndPoint}] operation canceled",
-          remoteEndPoint
-        );
+        Logger?.LogInformation("operation canceled");
         throw;
       }
 #pragma warning disable CA1031
       catch (Exception ex) {
         Logger?.LogCritical(
           ex,
-          "[{RemoteEndPoint}] unexpected exception while processing command",
-          remoteEndPoint
+          "unexpected exception while processing command"
         );
 
         await client.DisconnectAsync(cancellationToken).ConfigureAwait(false);