Refactor logging to allow a loggerfactory per session

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)
         {
         }
 

src/Renci.SshNet/ConnectionInfo.cs

@@ -5,6 +5,8 @@
 using System.Security.Cryptography;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 using Renci.SshNet.Compression;
 using Renci.SshNet.Messages.Authentication;
@@ -495,5 +497,13 @@ IList<IAuthenticationMethod> IConnectionInfoInternal.AuthenticationMethods
             get { return AuthenticationMethods.Cast<IAuthenticationMethod>().ToList(); }
 #pragma warning restore S2365 // Properties should not make collection or array copies
         }
+
+        /// <summary>
+        /// Gets or sets logger factory for this connection.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection. If <see langword="null"/> then <see cref="SshNetLoggingConfiguration.LoggerFactory"/> should be used.
+        /// </value>
+        public ILoggerFactory LoggerFactory { get; set; }
     }
 }

src/Renci.SshNet/ForwardedPortDynamic.cs

@@ -75,7 +75,7 @@ public ForwardedPortDynamic(string host, uint port)
             BoundHost = host;
             BoundPort = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortDynamic>();
+            _logger = Session.SessionLoggerFactory.CreateLogger<ForwardedPortDynamic>();
         }
 
         /// <summary>

src/Renci.SshNet/ForwardedPortLocal.cs

@@ -103,7 +103,7 @@ public ForwardedPortLocal(string boundHost, uint boundPort, string host, uint po
             Host = host;
             Port = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortLocal>();
+            _logger = Session.SessionLoggerFactory.CreateLogger<ForwardedPortLocal>();
         }
 
         /// <summary>

src/Renci.SshNet/ForwardedPortRemote.cs

@@ -100,7 +100,7 @@ public ForwardedPortRemote(IPAddress boundHostAddress, uint boundPort, IPAddress
             HostAddress = hostAddress;
             Port = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortRemote>();
+            _logger = Session.SessionLoggerFactory.CreateLogger<ForwardedPortRemote>();
         }
 
         /// <summary>

src/Renci.SshNet/IConnectionInfo.cs

@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 using Renci.SshNet.Messages.Connection;
 
@@ -12,6 +14,14 @@ namespace Renci.SshNet
     /// </summary>
     internal interface IConnectionInfo
     {
+        /// <summary>
+        /// Gets the logger factory for this connection.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection. If <see langword="null"/> then <see cref="SshNetLoggingConfiguration.LoggerFactory"/> should be used.
+        /// </value>
+        public ILoggerFactory LoggerFactory { get; }
+
         /// <summary>
         /// Gets the timeout to used when waiting for a server to acknowledge closing a channel.
         /// </summary>

src/Renci.SshNet/ISession.cs

@@ -3,6 +3,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Channels;
 using Renci.SshNet.Common;
 using Renci.SshNet.Messages;
@@ -22,6 +24,14 @@ internal interface ISession : IDisposable
         /// <value>The connection info.</value>
         IConnectionInfo ConnectionInfo { get; }
 
+        /// <summary>
+        /// Gets the logger factory for this session.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this session.
+        /// </value>
+        public ILoggerFactory SessionLoggerFactory { get; }
+
         /// <summary>
         /// Gets a value indicating whether the session is connected.
         /// </summary>

src/Renci.SshNet/ISubsystemSession.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Threading;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 
 namespace Renci.SshNet
@@ -10,6 +12,14 @@ namespace Renci.SshNet
     /// </summary>
     internal interface ISubsystemSession : IDisposable
     {
+        /// <summary>
+        /// Gets the logger factory for this subsystem session.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection.
+        /// </value>
+        public ILoggerFactory SessionLoggerFactory { get; }
+
         /// <summary>
         /// Gets or sets the number of milliseconds to wait for an operation to complete.
         /// </summary>

src/Renci.SshNet/Security/KeyExchange.cs

@@ -69,7 +69,7 @@ public byte[] ExchangeHash
         /// </summary>
         protected KeyExchange()
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = Session.SessionLoggerFactory.CreateLogger(GetType());
         }
 
         /// <inheritdoc/>

src/Renci.SshNet/ServiceFactory.cs

@@ -26,11 +26,8 @@ internal sealed partial class ServiceFactory : IServiceFactory
         /// </summary>
         private const int PartialSuccessLimit = 5;
 
-        private readonly ILogger _logger;
-
         internal ServiceFactory()
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ServiceFactory>();
         }
 
         /// <summary>
@@ -160,7 +157,7 @@ public ISftpFileReader CreateSftpFileReader(string fileName, ISftpSession sftpSe
                 fileSize = null;
                 maxPendingReads = defaultMaxPendingReads;
 
-                _logger.LogInformation(ex, "Failed to obtain size of file. Allowing maximum {MaxPendingReads} pending reads", maxPendingReads);
+                sftpSession.SessionLoggerFactory.CreateLogger<ServiceFactory>().LogInformation(ex, "Failed to obtain size of file. Allowing maximum {MaxPendingReads} pending reads", maxPendingReads);
             }
 
             return sftpSession.CreateFileReader(handle, sftpSession, chunkSize, maxPendingReads, fileSize);
@@ -221,16 +218,18 @@ public IConnector CreateConnector(IConnectionInfo connectionInfo, ISocketFactory
             ThrowHelper.ThrowIfNull(connectionInfo);
             ThrowHelper.ThrowIfNull(socketFactory);
 
+            var loggerFactory = connectionInfo.LoggerFactory ?? SshNetLoggingConfiguration.LoggerFactory;
+
             switch (connectionInfo.ProxyType)
             {
                 case ProxyTypes.None:
-                    return new DirectConnector(socketFactory);
+                    return new DirectConnector(socketFactory, loggerFactory);
                 case ProxyTypes.Socks4:
-                    return new Socks4Connector(socketFactory);
+                    return new Socks4Connector(socketFactory, loggerFactory);
                 case ProxyTypes.Socks5:
-                    return new Socks5Connector(socketFactory);
+                    return new Socks5Connector(socketFactory, loggerFactory);
                 case ProxyTypes.Http:
-                    return new HttpConnector(socketFactory);
+                    return new HttpConnector(socketFactory, loggerFactory);
                 default:
                     throw new NotSupportedException(string.Format("ProxyTypes '{0}' is not supported.", connectionInfo.ProxyType));
             }