🔧 (MigrationTools): centralize log path creation and improve logging

Refactor log path creation into a dedicated LogLocationService to centralize and simplify log path management. This change ensures consistent log path generation and usage across the application. Additionally, enhance logging by including log path information in log messages and enabling file size limits and rolling intervals for log files. This improves log management and helps in diagnosing issues by providing clear log locations.

src/MigrationTools.Host/Commands/CommandBase.cs

@@ -105,6 +105,7 @@ public sealed override async Task<int> ExecuteAsync(CommandContext context, TSet
                     Lifetime.StopApplication();
                     CommandActivity?.Stop();
                     _logger.LogInformation("Command {CommandName} completed in {Elapsed}", this.GetType().Name, CommandActivity?.Duration);
+                    _logger.LogInformation("Check the logs for errors: {LogPath}", LogLocationService.GetLogPath());
                 }
 
             }
@@ -196,6 +197,7 @@ private void ApplicationStartup(TSettings settings)
             _logger.LogInformation("Running with settings: {@settings}", settings);
             _logger.LogInformation("OSVersion: {OSVersion}", Environment.OSVersion.ToString());
             _logger.LogInformation("Version (Assembly): {Version}", _MigrationToolVersion.GetRunningVersion().versionString);
+            _logger.LogInformation("Logpath: {LogPath}", LogLocationService.GetLogPath());
         }
 
 

src/MigrationTools.Host/MigrationToolHost.cs

@@ -53,7 +53,7 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action<IConfigura
             var configFile = CommandSettingsBase.ForceGetConfigFile(args);
             var mtv = new MigrationToolVersion();
 
-            string logsPath = CreateLogsPath();
+            string logsPath = LogLocationService.GetLogPath();
 
             var hostBuilder = Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder(args);
 
@@ -66,8 +66,8 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action<IConfigura
                     .Enrich.WithProperty("versionString", mtv.GetRunningVersion().versionString)
                     .Enrich.FromLogContext()
                     .Enrich.WithProcessId()
-                    .WriteTo.File(Path.Combine(logsPath, $"migration.log"), LogEventLevel.Verbose, shared: true,outputTemplate: outputTemplate)
-                    .WriteTo.File(new Serilog.Formatting.Json.JsonFormatter(), Path.Combine(logsPath, $"migration-errors.log"), LogEventLevel.Error, shared: true)
+                    .WriteTo.File(Path.Combine(logsPath, $"migration.log"), LogEventLevel.Verbose, shared: true,outputTemplate: outputTemplate, rollOnFileSizeLimit: true, rollingInterval: RollingInterval.Hour)
+                    .WriteTo.File(new Serilog.Formatting.Json.JsonFormatter(), Path.Combine(logsPath, $"migration-errors.log"), LogEventLevel.Error, shared: true, rollOnFileSizeLimit: true, rollingInterval: RollingInterval.Day)
                     .WriteTo.Logger(lc => lc
                             .Filter.ByExcluding(Matching.FromSource("Microsoft.Hosting.Lifetime"))
                             .Filter.ByExcluding(Matching.FromSource("Microsoft.Extensions.Hosting.Internal.Host"))
@@ -141,20 +141,5 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action<IConfigura
             return hostBuilder;
         }
 
-        static string logDate = DateTime.Now.ToString("yyyyMMddHHmmss");
-
-        private static string CreateLogsPath()
-        {
-            string exportPath;
-            string assPath = Assembly.GetEntryAssembly().Location;
-            exportPath = Path.Combine(Path.GetDirectoryName(assPath), "logs", logDate);
-            if (!Directory.Exists(exportPath))
-            {
-                Directory.CreateDirectory(exportPath);
-            }
-
-            return exportPath;
-        }
-
     }
 }

src/MigrationTools/Services/LogLocationService.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Reflection;
+using System.Text;
+
+namespace MigrationTools.Services
+{
+   public class LogLocationService
+    {
+       private static string logDate = DateTime.Now.ToString("yyyyMMddHHmmss");
+
+
+       private static string _logsPath = CreateLogsPath();
+
+        public static string GetLogPath()
+        {
+            // Check if the string has been generated.
+            if (_logsPath == null)
+            {
+                // Generate the string at runtime (e.g., any custom logic).
+                _logsPath = CreateLogsPath();
+            }
+
+            // Return the _logsPath string.
+            return _logsPath;
+        }
+
+        private static string CreateLogsPath()
+        {
+            string exportPath;
+            string assPath = Assembly.GetEntryAssembly().Location;
+            exportPath = Path.Combine(Path.GetDirectoryName(assPath), "logs", logDate);
+            if (!Directory.Exists(exportPath))
+            {
+                Directory.CreateDirectory(exportPath);
+            }
+
+            return exportPath;
+        }
+    }
+}