Update logging

macaba · macaba · commit eefeabfb016a · 2025-10-04T15:15:40.000+01:00
diff --git a/source/TS.NET.Engine/Engine Tasks/HardwareThread.cs b/source/TS.NET.Engine/Engine Tasks/HardwareThread.cs
@@ -15,13 +15,13 @@ internal class HardwareThread : IEngineTask
         private CancellationTokenSource? cancelTokenSource;
         private Task? taskLoop;
 
-        public HardwareThread(ILoggerFactory loggerFactory,
+        public HardwareThread(ILogger logger,
             ThunderscopeSettings settings,
             IThunderscope thunderscope,
             BlockingPool<DataDto> hardwarePool,
             BlockingRequestResponse<HardwareRequestDto, HardwareResponseDto> hardwareControl)
         {
-            logger = loggerFactory.CreateLogger(nameof(HardwareThread));
+            this.logger = logger;
             this.settings = settings;
             this.thunderscope = thunderscope;
             this.hardwarePool = hardwarePool;
diff --git a/source/TS.NET.Engine/Engine Tasks/PreProcessingThread.cs b/source/TS.NET.Engine/Engine Tasks/PreProcessingThread.cs
@@ -13,12 +13,12 @@ public class PreProcessingThread : IEngineTask
         private Task? taskLoop;
 
         public PreProcessingThread(
-            ILoggerFactory loggerFactory,
+            ILogger logger,
             ThunderscopeSettings settings,
             BlockingPool<DataDto> hardwarePool,
             BlockingPool<DataDto> preProcessingPool)
         {
-            logger = loggerFactory.CreateLogger(nameof(PreProcessingThread));
+            this.logger = logger;
             this.settings = settings;
             this.hardwarePool = hardwarePool;
             this.preProcessingPool = preProcessingPool;
diff --git a/source/TS.NET.Engine/Engine Tasks/ProcessingThread.cs b/source/TS.NET.Engine/Engine Tasks/ProcessingThread.cs
@@ -18,7 +18,7 @@ public class ProcessingThread : IEngineTask
         private Task? taskLoop;
 
         public ProcessingThread(
-            ILoggerFactory loggerFactory,
+            ILogger logger,
             ThunderscopeSettings settings,
             ThunderscopeHardwareConfig hardwareConfig,
             BlockingPool<DataDto> preProcessingPool,
@@ -27,7 +27,7 @@ public ProcessingThread(
             BlockingChannelWriter<INotificationDto>? uiNotifications,
             CaptureCircularBuffer captureBuffer)
         {
-            logger = loggerFactory.CreateLogger(nameof(ProcessingThread));
+            this.logger = logger;
             this.settings = settings;
             this.hardwareConfig = hardwareConfig;
             this.preProcessingPool = preProcessingPool;
diff --git a/source/TS.NET.Engine/Engine Tasks/ScpiServer.cs b/source/TS.NET.Engine/Engine Tasks/ScpiServer.cs
@@ -13,14 +13,14 @@ class ScpiServer : TcpServer, IEngineTask
         private readonly BlockingRequestResponse<HardwareRequestDto, HardwareResponseDto> hardwareControl;
         private readonly BlockingRequestResponse<ProcessingRequestDto, ProcessingResponseDto> processingControl;
 
-        public ScpiServer(ILoggerFactory loggerFactory,
+        public ScpiServer(ILogger logger,
             ThunderscopeSettings settings,
             IPAddress address,
             int port,
             BlockingRequestResponse<HardwareRequestDto, HardwareResponseDto> hardwareControl,
             BlockingRequestResponse<ProcessingRequestDto, ProcessingResponseDto> processingControl) : base(address, port)
         {
-            logger = loggerFactory.CreateLogger(nameof(ScpiServer));
+            this.logger = logger;
             this.settings = settings;
             this.hardwareControl = hardwareControl;
             this.processingControl = processingControl;
diff --git a/source/TS.NET.Engine/EngineManager.cs b/source/TS.NET.Engine/EngineManager.cs
@@ -1,7 +1,5 @@
 ﻿using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
-using NReco.Logging.File;
-using System.IO;
 using System.Runtime.InteropServices;
 using System.Runtime.Intrinsics.Arm;
 using System.Runtime.Intrinsics.X86;
@@ -17,6 +15,9 @@ namespace TS.NET.Engine
     //   By serialising the config-update/data-read it also allows for specific behaviours (like pausing acquisition on certain config updates) and ensuring a perfect match between sample-block & hardware configuration that created it.
     public class EngineManager
     {
+        private readonly ILoggerFactory loggerFactory;
+        private readonly ILogger logger;
+
         private ThunderscopeSettings? thunderscopeSettings = null;
         private IThunderscope? thunderscope = null;
 
@@ -28,6 +29,12 @@ public class EngineManager
 
         public BlockingChannel<INotificationDto>? UiNotifications;
 
+        public EngineManager(ILoggerFactory loggerFactory)
+        {
+            this.loggerFactory = loggerFactory;
+            logger = loggerFactory.CreateLogger(nameof(EngineManager));
+        }
+
         public bool TryStart(string configurationFile, string calibrationFile, string deviceSerial)
         {
             Console.CancelKeyPress += (sender, e) => { StopLibtslitex(); Environment.Exit(0); };    // Handle Ctrl+C or Ctrl+Break event.
@@ -40,27 +47,9 @@ public bool TryStart(string configurationFile, string calibrationFile, string de
             // Commented out for now, more testing needed on Windows
             //using FileStream fs = new(lockFilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None);
 
-            IConfigurationBuilder configurationBuilder = new ConfigurationBuilder().AddJsonFile(
-                "thunderscope-appsettings.json"
-            );
-            var configuration = configurationBuilder.Build();
             thunderscopeSettings = ThunderscopeSettings.FromYamlFile(configurationFile);
             var thunderscopeCalibrationSettings = ThunderscopeCalibrationSettings.FromJsonFile(calibrationFile);
 
-            var loggerFactory = LoggerFactory.Create(configure =>
-            {
-                configure
-                    .ClearProviders()
-                    .AddConfiguration(configuration.GetSection("Logging"))
-                    .AddFile(configuration.GetSection("Logging"))
-                    .AddSimpleConsole(options =>
-                    {
-                        options.SingleLine = true;
-                        options.TimestampFormat = "HH:mm:ss ";
-                    });
-            });
-            var logger = loggerFactory.CreateLogger("TS.NET.Engine");
-
             if (RuntimeInformation.ProcessArchitecture == Architecture.X86 || RuntimeInformation.ProcessArchitecture == Architecture.X64)
             {
                 if (!Avx2.IsSupported)
@@ -172,7 +161,7 @@ public bool TryStart(string configurationFile, string calibrationFile, string de
 
             startSemaphore.Wait();
             processingThread = new ProcessingThread(
-                loggerFactory: loggerFactory,
+                logger: loggerFactory.CreateLogger(nameof(ProcessingThread)),
                 settings: thunderscopeSettings,
                 hardwareConfig: thunderscope.GetConfiguration(),
                 preProcessingPool: preProcessingPool,
@@ -184,15 +173,15 @@ public bool TryStart(string configurationFile, string calibrationFile, string de
 
             startSemaphore.Wait();
             preProcessingThread = new PreProcessingThread(
-                loggerFactory: loggerFactory,
+                logger: loggerFactory.CreateLogger(nameof(PreProcessingThread)),
                 settings: thunderscopeSettings,
                 hardwarePool: hardwarePool,
                 preProcessingPool: preProcessingPool);
             preProcessingThread.Start(startSemaphore);
 
             startSemaphore.Wait();
             hardwareThread = new HardwareThread(
-                loggerFactory: loggerFactory,
+                logger: loggerFactory.CreateLogger(nameof(HardwareThread)),
                 settings: thunderscopeSettings,
                 thunderscope: thunderscope,
                 hardwarePool: hardwarePool,
@@ -201,7 +190,7 @@ public bool TryStart(string configurationFile, string calibrationFile, string de
 
             startSemaphore.Wait();
             scpiServer = new ScpiServer(
-                loggerFactory,
+                logger: loggerFactory.CreateLogger(nameof(ScpiServer)),
                 thunderscopeSettings,
                 System.Net.IPAddress.Any,
                 5025,
@@ -213,7 +202,7 @@ public bool TryStart(string configurationFile, string calibrationFile, string de
             switch (thunderscopeSettings.WaveformBufferReader)
             {
                 case "DataServer":
-                    DataServer dataServer = new(loggerFactory, thunderscopeSettings, System.Net.IPAddress.Any, 5026, captureBuffer);
+                    DataServer dataServer = new(loggerFactory.CreateLogger(nameof(DataServer)), thunderscopeSettings, System.Net.IPAddress.Any, 5026, captureBuffer);
                     waveformBufferReader = dataServer;
                     break;
                 case "None":
diff --git a/source/TS.NET.Engine/Program.cs b/source/TS.NET.Engine/Program.cs
@@ -1,4 +1,7 @@
-﻿using System.CommandLine;
+﻿using Microsoft.Extensions.Logging;
+using Serilog;
+using Serilog.Sinks.SystemConsole.Themes;
+using System.CommandLine;
 using System.Text.Json;
 using TS.NET;
 using TS.NET.Engine;
@@ -54,7 +57,35 @@ static void Start(int deviceIndex, string configurationFile, string calibrationF
         File.WriteAllText("thunderscope-calibration (defaults).json", json);
 #endif
 
-        var engine = new EngineManager();
+        //IConfigurationBuilder configurationBuilder = new ConfigurationBuilder().AddJsonFile("thunderscope-appsettings.json");
+        //var configuration = configurationBuilder.Build();
+
+#if DEBUG
+        var serilog = new LoggerConfiguration()
+            .MinimumLevel.Debug()
+            .MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Warning)
+            .Enrich.FromLogContext()
+            .WriteTo.Console(
+                theme: AnsiConsoleTheme.Code,
+                outputTemplate: "[{Timestamp:HH:mm:ss} {Level:w4}] {SourceContext} {Message:lj}{NewLine}{Exception}"
+            )
+            .WriteTo.File("Logs/TS.NET.Engine .txt", rollingInterval: RollingInterval.Day)
+            .CreateLogger();
+#else
+        var serilog = new LoggerConfiguration()
+            .MinimumLevel.Information()
+            .MinimumLevel.Override("Microsoft", Serilog.Events.LogEventLevel.Warning)
+            .Enrich.FromLogContext()
+            .WriteTo.Console(
+                theme: AnsiConsoleTheme.Code,
+                outputTemplate: "[{Timestamp:HH:mm:ss} {Level:w4}] {SourceContext} {Message:lj}{NewLine}{Exception}"
+            )
+            .CreateLogger();
+#endif
+        var loggerFactory = new LoggerFactory().AddSerilog(serilog);
+        var logger = loggerFactory.CreateLogger("TS.NET.Engine");
+
+        var engine = new EngineManager(loggerFactory);
         var deviceSerial = deviceIndex.ToString();
         if (!engine.TryStart(configurationFile, calibrationFile, deviceSerial))
             return;
diff --git a/source/TS.NET.Engine/TS.NET.Engine.csproj b/source/TS.NET.Engine/TS.NET.Engine.csproj
@@ -22,8 +22,10 @@
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="9.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="9.0.0" />
     <PackageReference Include="NetCoreServer" Version="8.0.7" />
-    <PackageReference Include="NReco.Logging.File" Version="1.2.1" />
     <PackageReference Include="Riok.Mapperly" Version="4.2.1" />
+    <PackageReference Include="Serilog.Extensions.Logging" Version="9.0.2" />
+    <PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
+    <PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
     <PackageReference Include="Vecc.YamlDotNet.Analyzers.StaticGenerator" Version="16.2.0" />
     <PackageReference Include="YamlDotNet" Version="16.2.0" />
@@ -37,9 +39,6 @@
     <None Update="thunderscope-calibration.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="thunderscope-appsettings.json">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
     <None Update="thunderscope.json">
       <CopyToOutputDirectory>Never</CopyToOutputDirectory>
     </None>
diff --git a/source/TS.NET.Engine/Waveform Buffer Readers/DataServer.cs b/source/TS.NET.Engine/Waveform Buffer Readers/DataServer.cs
@@ -14,9 +14,14 @@ internal class DataServer : TcpServer, IEngineTask
         private readonly CancellationTokenSource cancellationTokenSource;
         private readonly ICaptureBufferReader captureBuffer;
 
-        public DataServer(ILoggerFactory loggerFactory, ThunderscopeSettings settings, IPAddress address, int port, ICaptureBufferReader captureBuffer) : base(address, port)
+        public DataServer(
+            ILogger logger, 
+            ThunderscopeSettings settings, 
+            IPAddress address, 
+            int port, 
+            ICaptureBufferReader captureBuffer) : base(address, port)
         {
-            logger = loggerFactory.CreateLogger(nameof(DataServer));
+            this.logger = logger;
             cancellationTokenSource = new();
             this.captureBuffer = captureBuffer;
             logger.LogDebug("Started");
diff --git a/source/TS.NET.Engine/thunderscope-appsettings.json b/source/TS.NET.Engine/thunderscope-appsettings.json
