Refactor logging to allow a loggerfactory per session specified in the ConnectionInfo.

This commit introduces an `ILoggerFactory` to various classes, replacing the static logger factory with an instance-based approach for more flexible and session-specific logging. These changes improve the logging framework's flexibility and maintainability and allow unit testing of logging.

Author: desdesdes

src/Renci.SshNet/BaseClient.cs

@@ -20,8 +20,6 @@ public abstract class BaseClient : IBaseClient
         /// Holds value indicating whether the connection info is owned by this client.
         /// </summary>
         private readonly bool _ownsConnectionInfo;
-
-        private readonly ILogger _logger;
         private readonly IServiceFactory _serviceFactory;
         private readonly object _keepAliveLock = new object();
         private TimeSpan _keepAliveInterval;
@@ -37,6 +35,14 @@ public abstract class BaseClient : IBaseClient
         /// </value>
         internal ISession? Session { get; private set; }
 
+        internal ILogger? Logger
+        {
+            get
+            {
+                return Session?.SessionLoggerFactory?.CreateLogger(GetType());
+            }
+        }
+
         /// <summary>
         /// Gets the factory for creating new services.
         /// </summary>
@@ -192,7 +198,6 @@ private protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionI
             _connectionInfo = connectionInfo;
             _ownsConnectionInfo = ownsConnectionInfo;
             _serviceFactory = serviceFactory;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
             _keepAliveInterval = Timeout.InfiniteTimeSpan;
         }
 
@@ -346,7 +351,7 @@ public async Task ConnectAsync(CancellationToken cancellationToken)
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         public void Disconnect()
         {
-            _logger.LogInformation("Disconnecting client.");
+            Logger?.LogInformation("Disconnecting client.");
 
             CheckDisposed();
 
@@ -445,7 +450,7 @@ protected virtual void Dispose(bool disposing)
 
             if (disposing)
             {
-                _logger.LogDebug("Disposing client.");
+                Logger?.LogDebug("Disposing client.");
 
                 Disconnect();
 
@@ -508,7 +513,7 @@ private void SendKeepAliveMessage()
                 }
                 catch (Exception ex)
                 {
-                    _logger.LogError(ex, "Error sending keepalive message");
+                    Logger?.LogError(ex, "Error sending keepalive message");
                 }
                 finally
                 {

src/Renci.SshNet/Channels/Channel.cs

@@ -84,7 +84,7 @@ protected Channel(ISession session, uint localChannelNumber, uint localWindowSiz
             LocalChannelNumber = localChannelNumber;
             LocalPacketSize = localPacketSize;
             LocalWindowSize = localWindowSize;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = session.SessionLoggerFactory.CreateLogger(GetType());
 
             session.ChannelWindowAdjustReceived += OnChannelWindowAdjust;
             session.ChannelDataReceived += OnChannelData;

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -33,7 +33,7 @@ internal sealed class ChannelDirectTcpip : ClientChannel, IChannelDirectTcpip
         public ChannelDirectTcpip(ISession session, uint localChannelNumber, uint localWindowSize, uint localPacketSize)
             : base(session, localChannelNumber, localWindowSize, localPacketSize)
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ChannelDirectTcpip>();
+            _logger = session.SessionLoggerFactory.CreateLogger<ChannelDirectTcpip>();
         }
 
         /// <summary>

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -48,7 +48,7 @@ internal ChannelForwardedTcpip(ISession session,
                    remoteWindowSize,
                    remotePacketSize)
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ChannelForwardedTcpip>();
+            _logger = session.SessionLoggerFactory.CreateLogger<ChannelForwardedTcpip>();
         }
 
         /// <summary>

src/Renci.SshNet/Connection/ConnectorBase.cs

@@ -15,13 +15,15 @@ namespace Renci.SshNet.Connection
     internal abstract class ConnectorBase : IConnector
     {
         private readonly ILogger _logger;
+        private readonly ILoggerFactory _loggerFactory;
 
-        protected ConnectorBase(ISocketFactory socketFactory)
+        protected ConnectorBase(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
         {
             ThrowHelper.ThrowIfNull(socketFactory);
 
             SocketFactory = socketFactory;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _loggerFactory = loggerFactory;
+            _logger = _loggerFactory.CreateLogger(GetType());
         }
 
         internal ISocketFactory SocketFactory { get; private set; }

src/Renci.SshNet/Connection/DirectConnector.cs

@@ -2,12 +2,14 @@
 using System.Net.Sockets;
 using System.Threading;
 
+using Microsoft.Extensions.Logging;
+
 namespace Renci.SshNet.Connection
 {
     internal sealed class DirectConnector : ConnectorBase
     {
-        public DirectConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public DirectConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/HttpConnector.cs

@@ -5,6 +5,8 @@
 using System.Net.Sockets;
 using System.Text.RegularExpressions;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -48,8 +50,8 @@ internal sealed partial class HttpConnector : ProxyConnector
         private static readonly Regex HttpHeaderRegex = new Regex(HttpHeaderPattern, RegexOptions.Compiled);
 #endif
 
-        public HttpConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public HttpConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/ProxyConnector.cs

@@ -4,6 +4,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 
+using Microsoft.Extensions.Logging;
+
 namespace Renci.SshNet.Connection
 {
     /// <summary>
@@ -12,8 +14,8 @@ namespace Renci.SshNet.Connection
     /// </summary>
     internal abstract class ProxyConnector : ConnectorBase
     {
-        protected ProxyConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        protected ProxyConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/Socks4Connector.cs

@@ -4,6 +4,8 @@
 using System.Net.Sockets;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -17,8 +19,8 @@ namespace Renci.SshNet.Connection
     /// </remarks>
     internal sealed class Socks4Connector : ProxyConnector
     {
-        public Socks4Connector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public Socks4Connector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/Socks5Connector.cs

@@ -5,6 +5,8 @@
 using System.Net.Sockets;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -18,8 +20,8 @@ namespace Renci.SshNet.Connection
     /// </remarks>
     internal sealed class Socks5Connector : ProxyConnector
     {
-        public Socks5Connector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public Socks5Connector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }