Merge pull request #508 from GridProtectionAlliance/route-dnp3-logs

Dnp3Adapters: Route log messages to the appropriate adapter

Author: ritchiecarroll

Source/Libraries/Adapters/Dnp3Adapters/Dnp3InputAdapter.cs

@@ -173,6 +173,16 @@ public double PollingInterval
         set => m_pollingInterval = TimeSpan.FromSeconds(value);
     }
 
+    /// <inheritdoc/>
+    public string ChannelID
+    {
+        get
+        {
+            TcpClientConfig tcpConfig = m_masterConfig.client;
+            return $"{tcpConfig.address}:{tcpConfig.port}";
+        }
+    }
+
     /// <summary>
     /// Gets the flag indicating if this adapter supports temporal processing.
     /// </summary>
@@ -311,17 +321,16 @@ public override void Initialize()
     protected override void AttemptConnection()
     {
         TcpClientConfig tcpConfig = m_masterConfig.client;
-        string endPoint = $"{tcpConfig.address}:{tcpConfig.port}";
         TimeSpan minRetry = TimeSpan.FromMilliseconds(tcpConfig.minRetryMs);
         TimeSpan maxRetry = TimeSpan.FromMilliseconds(tcpConfig.maxRetryMs);
         TimeSpan reconnectDelay = TimeSpan.FromMilliseconds(tcpConfig.reconnectDelayMs);
         ChannelRetry channelRetry = new(minRetry, maxRetry, reconnectDelay);
-        IChannelListener channelListener = new ChannelListener(state => OnStatusMessage(MessageLevel.Info, $"{endPoint} - Channel state change: {state}"));
+        IChannelListener channelListener = new ChannelListener(state => OnStatusMessage(MessageLevel.Info, $"{ChannelID} - Channel state change: {state}"));
 
-        IChannel channel = s_manager.AddTCPClient(endPoint, tcpConfig.level, channelRetry, [new IPEndpoint(tcpConfig.address, tcpConfig.port)], channelListener);
+        IChannel channel = s_manager.AddTCPClient(ChannelID, tcpConfig.level, channelRetry, [new IPEndpoint(tcpConfig.address, tcpConfig.port)], channelListener);
         m_channel = channel;
 
-        IMaster master = channel.AddMaster(endPoint, m_soeHandler, DefaultMasterApplication.Instance, m_masterConfig.master);
+        IMaster master = channel.AddMaster(ChannelID, m_soeHandler, DefaultMasterApplication.Instance, m_masterConfig.master);
 
         if (m_pollingInterval > TimeSpan.Zero)
             master.AddClassScan(ClassField.AllClasses, m_pollingInterval, m_soeHandler, TaskConfig.Default);

Source/Libraries/Adapters/Dnp3Adapters/Dnp3OutputAdapter.cs

@@ -431,6 +431,9 @@ public Dnp3OutputAdapter()
     /// <inheritdoc />
     public override bool OutputIsForArchive => false;
 
+    /// <inheritdoc/>
+    public string ChannelID => $"gsf-dnp3-outstation:{Name}";
+
     /// <inheritdoc />
     protected override bool UseAsyncConnect => false;
 
@@ -582,7 +585,7 @@ protected override void AttemptConnection()
     {
         // TCP server channel (listener)
         m_channel = s_manager.AddTCPServer(
-            $"gsf-dnp3-outstation:{Name}",
+            ChannelID,
             getLogLevel(),
             ServerAcceptMode.CloseExisting,
             new IPEndpoint(Interface, Port),
@@ -622,7 +625,7 @@ protected override void AttemptConnection()
 
         // Create a GSF outstation application that includes adapter logging
         m_outstation = m_channel.AddOutstation(
-            $"gsf-dnp3-outstation:{Name}",
+            ChannelID,
             new ReadOnlyCommandHandler(),
             new GSFOutstationApplication(this),
             outstationStackConfig

Source/Libraries/Adapters/Dnp3Adapters/IaonProxyLogHandler.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text;
 using Automatak.DNP3.Interface;
 using GSF.Diagnostics;
@@ -14,6 +15,11 @@ namespace DNP3Adapters;
 /// </summary>
 public interface IDnp3Adapter : IAdapter
 {
+    /// <summary>
+    /// Gets the ID of the channel added to the DNP3 manager.
+    /// </summary>
+    public string ChannelID { get; }
+
     /// <summary>
     /// Raises the <see cref="IAdapter.ProcessException"/> event.
     /// </summary>
@@ -34,7 +40,7 @@ internal class IaonProxyLogHandler<T> : ILogHandler where T : IDnp3Adapter
     /// <summary>
     /// Gets the static adapters that are currently registered with this proxy.
     /// </summary>
-    public List<IDnp3Adapter> Adapters { get; } = [];
+    public Dictionary<string, IDnp3Adapter> Adapters { get; } = [];
 
     /// <summary>
     /// Gets the static status proxy that is used to process exceptions and status messages.
@@ -50,7 +56,7 @@ public void RegisterAdapter(T adapter)
         lock (Adapters)
         {
             // Add adapter to list of available adapters 
-            Adapters.Add(adapter);
+            Adapters.Add(adapter.ChannelID, adapter);
 
             // If no adapter has been designated as the status proxy, assign this one
             StatusProxy ??= adapter;
@@ -66,13 +72,13 @@ public void UnregisterAdapter(T adapter)
         lock (Adapters)
         {
             // Remove this adapter from the available list
-            Adapters.Remove(adapter);
+            Adapters.Remove(adapter.ChannelID);
 
             // See if we are disposing the status proxy instance
             if (ReferenceEquals(StatusProxy, adapter))
             {
                 // Attempt to find a new status proxy
-                StatusProxy = Adapters.Count > 0 ? Adapters[0] : null;
+                StatusProxy = Adapters.Values.FirstOrDefault();
             }
         }
     }
@@ -87,26 +93,29 @@ public void Log(LogEntry entry)
         // contends with adapter initialization and disposal so contention will not be the normal case
         lock (Adapters)
         {
-            if (StatusProxy is null || StatusProxy.IsDisposed)
+            if (!Adapters.TryGetValue(entry.alias, out IDnp3Adapter? adapter))
+                adapter = StatusProxy;
+
+            if (adapter is null || adapter.IsDisposed)
                 return;
 
             if ((entry.filter.Flags & LogFilters.ERROR) > 0)
             {
                 // Expose errors through exception processor
                 InvalidOperationException exception = new(FormatLogEntry(entry));
-                StatusProxy.OnProcessException(MessageLevel.Error, exception);
+                adapter.OnProcessException(MessageLevel.Error, exception);
             }
             else
             {
                 // For other messages, we just expose as a normal status
                 string message = FormatLogEntry(entry);
 
                 if ((entry.filter.Flags & LogFilters.WARNING) > 0)
-                    StatusProxy.OnStatusMessage(MessageLevel.Warning, message);
+                    adapter.OnStatusMessage(MessageLevel.Warning, message);
                 else if ((entry.filter.Flags & LogFilters.DEBUG) > 0)
-                    StatusProxy.OnStatusMessage(MessageLevel.Debug, message);
+                    adapter.OnStatusMessage(MessageLevel.Debug, message);
                 else
-                    StatusProxy.OnStatusMessage(MessageLevel.Info, message);
+                    adapter.OnStatusMessage(MessageLevel.Info, message);
             }
         }
     }