Reuse ClassLoggers (#7509)

NethermindEth · Sep 30, 2024 · 471412a · 471412a
1 parent b4b0b02
commit 471412a
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 14 deletions.
diff --git a/src/Nethermind/Nethermind.Core.Test/NUnitLogManager.cs b/src/Nethermind/Nethermind.Core.Test/NUnitLogManager.cs
@@ -2,6 +2,8 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
+
 using Nethermind.Logging;
 
 namespace Nethermind.Core.Test
@@ -20,7 +22,7 @@ public NUnitLogManager(LogLevel level = LogLevel.Info)
 
         public ILogger GetClassLogger<T>() => GetClassLogger();
 
-        public ILogger GetClassLogger() => new(_logger);
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => new(_logger);
 
         public ILogger GetLogger(string loggerName) => GetClassLogger();
     }

diff --git a/src/Nethermind/Nethermind.Logging.NLog/NLogManager.cs b/src/Nethermind/Nethermind.Logging.NLog/NLogManager.cs
@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Text.RegularExpressions;
 using NLog;
 using NLog.Config;
@@ -58,18 +59,28 @@ private static string SetupLogDirectory(string logDirectory)
         }
 
         private static readonly ConcurrentDictionary<Type, ILogger> s_loggers = new();
+        private static readonly ConcurrentDictionary<string, ILogger> s_namedLoggers = new();
         private static readonly Func<Type, ILogger> s_loggerBuilder = BuildLogger;
+        private static readonly Func<string, ILogger> s_namedLoggerBuilder = BuildNamedLogger;
+        private static readonly Func<string, ILogger> s_classLoggerBuilder = BuildClassLogger;
         private readonly EventHandler<LoggingConfigurationChangedEventArgs> _logManagerOnConfigurationChanged;
 
-        private static ILogger BuildLogger(Type type) => new(new NLogLogger(type));
+        private static ILogger BuildLogger(Type type)
+            => new(new NLogLogger(type));
+        private static ILogger BuildNamedLogger(string loggerName)
+            => new(new NLogLogger(loggerName));
+        private static ILogger BuildClassLogger(string filePath)
+            => new(new NLogLogger());
 
         public ILogger GetClassLogger(Type type) => s_loggers.GetOrAdd(type, s_loggerBuilder);
 
         public ILogger GetClassLogger<T>() => GetClassLogger(typeof(T));
 
-        public ILogger GetClassLogger() => new(new NLogLogger());
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => !string.IsNullOrEmpty(filePath) ?
+            s_namedLoggers.GetOrAdd(filePath, s_classLoggerBuilder) :
+            new(new NLogLogger());
 
-        public ILogger GetLogger(string loggerName) => new(new NLogLogger(loggerName));
+        public ILogger GetLogger(string loggerName) => s_namedLoggers.GetOrAdd(loggerName, s_namedLoggerBuilder);
 
         public void SetGlobalVariable(string name, object value)
         {

diff --git a/src/Nethermind/Nethermind.Logging/ILogManager.cs b/src/Nethermind/Nethermind.Logging/ILogManager.cs
@@ -2,14 +2,15 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging
 {
     public interface ILogManager
     {
         ILogger GetClassLogger(Type type);
         ILogger GetClassLogger<T>();
-        ILogger GetClassLogger();
+        ILogger GetClassLogger([CallerFilePath] string filePath = "");
         ILogger GetLogger(string loggerName);
 
         void SetGlobalVariable(string name, object value) { }

diff --git a/src/Nethermind/Nethermind.Logging/LimboLogs.cs b/src/Nethermind/Nethermind.Logging/LimboLogs.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 using System.Threading;
 
 namespace Nethermind.Logging
@@ -29,7 +30,7 @@ private LimboLogs()
 
         public ILogger GetClassLogger<T>() => LimboTraceLogger.Instance;
 
-        public ILogger GetClassLogger() => LimboTraceLogger.Instance;
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => LimboTraceLogger.Instance;
 
         public ILogger GetLogger(string loggerName) => LimboTraceLogger.Instance;
     }

diff --git a/src/Nethermind/Nethermind.Logging/NoErrorLimboLogs.cs b/src/Nethermind/Nethermind.Logging/NoErrorLimboLogs.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 using System.Threading;
 
 namespace Nethermind.Logging
@@ -23,7 +24,7 @@ private NoErrorLimboLogs()
 
         public ILogger GetClassLogger<T>() => LimboNoErrorLogger.Instance;
 
-        public ILogger GetClassLogger() => LimboNoErrorLogger.Instance;
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => LimboNoErrorLogger.Instance;
 
         public ILogger GetLogger(string loggerName) => LimboNoErrorLogger.Instance;
     }

diff --git a/src/Nethermind/Nethermind.Logging/NullLogManager.cs b/src/Nethermind/Nethermind.Logging/NullLogManager.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging
 {
@@ -17,7 +18,7 @@ private NullLogManager()
 
         public ILogger GetClassLogger<T>() => NullLogger.Instance;
 
-        public ILogger GetClassLogger() => NullLogger.Instance;
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => NullLogger.Instance;
 
         public ILogger GetLogger(string loggerName) => NullLogger.Instance;
     }

diff --git a/src/Nethermind/Nethermind.Logging/OneLoggerLogManager.cs b/src/Nethermind/Nethermind.Logging/OneLoggerLogManager.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging
 {
@@ -18,7 +19,7 @@ public OneLoggerLogManager(ILogger logger)
 
         public ILogger GetClassLogger<T>() => _logger;
 
-        public ILogger GetClassLogger() => _logger;
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => _logger;
 
         public ILogger GetLogger(string loggerName) => _logger;
     }

diff --git a/src/Nethermind/Nethermind.Logging/SimpleConsoleLogManager.cs b/src/Nethermind/Nethermind.Logging/SimpleConsoleLogManager.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging
 {
@@ -23,7 +24,7 @@ public ILogger GetClassLogger<T>()
             return new(SimpleConsoleLogger.Instance);
         }
 
-        public ILogger GetClassLogger()
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "")
         {
             return new(SimpleConsoleLogger.Instance);
         }

diff --git a/src/Nethermind/Nethermind.Logging/TestErrorLogManager.cs b/src/Nethermind/Nethermind.Logging/TestErrorLogManager.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging;
 
@@ -17,7 +18,7 @@ public class TestErrorLogManager : ILogManager
 
     public ILogger GetClassLogger<T>() => GetClassLogger();
 
-    public ILogger GetClassLogger() => new(new TestErrorLogger(_errors));
+    public ILogger GetClassLogger([CallerFilePath] string filePath = "") => new(new TestErrorLogger(_errors));
 
     public ILogger GetLogger(string loggerName) => GetClassLogger();
 

diff --git a/src/Nethermind/Nethermind.Logging/TestLogManager.cs b/src/Nethermind/Nethermind.Logging/TestLogManager.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 
 using System;
+using System.Runtime.CompilerServices;
 
 namespace Nethermind.Logging
 {
@@ -20,7 +21,7 @@ public TestLogManager(LogLevel level = LogLevel.Info)
 
         public ILogger GetClassLogger<T>() => GetClassLogger();
 
-        public ILogger GetClassLogger() => new(new NUnitLogger(_level));
+        public ILogger GetClassLogger([CallerFilePath] string filePath = "") => new(new NUnitLogger(_level));
 
         public ILogger GetLogger(string loggerName) => GetClassLogger();
 

diff --git a/src/Nethermind/Nethermind.Merge.Plugin.Test/EngineModuleTests.V1.cs b/src/Nethermind/Nethermind.Merge.Plugin.Test/EngineModuleTests.V1.cs
@@ -1583,7 +1583,7 @@ public async Task Should_warn_for_missing_capabilities()
         var iLogger = Substitute.For<InterfaceLogger>();
         iLogger.IsWarn.Returns(true);
         var logger = new ILogger(iLogger);
-        loggerManager.GetClassLogger().Returns(logger);
+        loggerManager.GetClassLogger(Arg.Any<string>()).Returns(logger);
 
         chain.LogManager = loggerManager;
 

diff --git a/src/Nethermind/Nethermind.Synchronization.Test/SyncReportTest.cs b/src/Nethermind/Nethermind.Synchronization.Test/SyncReportTest.cs
@@ -76,7 +76,7 @@ public void Ancient_bodies_and_receipts_are_reported_correctly(
             iLogger.IsInfo.Returns(true);
             iLogger.IsError.Returns(true);
             ILogger logger = new(iLogger);
-            logManager.GetClassLogger().Returns(logger);
+            logManager.GetClassLogger(Arg.Any<string>()).Returns(logger);
 
             Queue<SyncMode> syncModes = new();
             syncModes.Enqueue(SyncMode.FastHeaders);