From aa08a9a866d6934b2f76fde481ab011de2209d2d Mon Sep 17 00:00:00 2001
From: "Martin Hinshelwood nkdAgility.com" <martin@nkdagility.com>
Date: Mon, 23 Sep 2024 14:52:24 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20(MigrationTools):=20centralize?=
 =?UTF-8?q?=20log=20path=20creation=20and=20improve=20logging?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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.
---
 docs/Reference/Generated/MigrationTools.xml   | 16 +++----
 .../Commands/CommandBase.cs                   |  2 +
 src/MigrationTools.Host/MigrationToolHost.cs  | 21 ++--------
 .../Services/LogLocationService.cs            | 42 +++++++++++++++++++
 4 files changed, 55 insertions(+), 26 deletions(-)
 create mode 100644 src/MigrationTools/Services/LogLocationService.cs

diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
index bb9d5cb61..316d83c58 100644
--- a/docs/Reference/Generated/MigrationTools.xml
+++ b/docs/Reference/Generated/MigrationTools.xml
@@ -258,22 +258,22 @@
         </member>
         <member name="F:ThisAssembly.Git.Branch">
             <summary>
-            => @"main"
+            => @"topic/output-log-location"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.Commit">
             <summary>
-            => @"76c49c7b"
+            => @"718c3190"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.Sha">
             <summary>
-            => @"76c49c7bd212b11211a22924e6ad4e36339739b8"
+            => @"718c31903c2750f5170ac91a202c51682b4ebb13"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.CommitDate">
             <summary>
-            => @"2024-09-16T00:57:48+01:00"
+            => @"2024-09-19T09:18:52+01:00"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.Commits">
@@ -283,12 +283,12 @@
         </member>
         <member name="F:ThisAssembly.Git.Tag">
             <summary>
-            => @"v16.0.4-Preview.2"
+            => @"v16.0.4-Preview.3"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.BaseTag">
             <summary>
-            => @"v16.0.4-Preview.2"
+            => @"v16.0.4-Preview.3"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.BaseVersion.Major">
@@ -323,12 +323,12 @@
         </member>
         <member name="F:ThisAssembly.Git.SemVer.Label">
             <summary>
-            => @"Preview.2"
+            => @"Preview.3"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.SemVer.DashLabel">
             <summary>
-            => @"-Preview.2"
+            => @"-Preview.3"
             </summary>
         </member>
         <member name="F:ThisAssembly.Git.SemVer.Source">
diff --git a/src/MigrationTools.Host/Commands/CommandBase.cs b/src/MigrationTools.Host/Commands/CommandBase.cs
index 13d8fc1e3..cf81c742e 100644
--- a/src/MigrationTools.Host/Commands/CommandBase.cs
+++ b/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());
         }
 
 
diff --git a/src/MigrationTools.Host/MigrationToolHost.cs b/src/MigrationTools.Host/MigrationToolHost.cs
index e0c47fc83..4570090ce 100644
--- a/src/MigrationTools.Host/MigrationToolHost.cs
+++ b/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;
-        }
-
     }
 }
\ No newline at end of file
diff --git a/src/MigrationTools/Services/LogLocationService.cs b/src/MigrationTools/Services/LogLocationService.cs
new file mode 100644
index 000000000..c0f123ccb
--- /dev/null
+++ b/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;
+        }
+    }
+}