Dev/Add File Logging (#96)

* Add first iteration of to file logging

* Change path

* Improve some basics

* Improve the basics again

* Rework file logging again to create one file per day

* Use existing path again, better

* Revert previous commit

* Add new directory to GitHub Workflow and adjust VSCode

Author: Sella-GH

.github/workflows/dotnet-release-publish.yml

@@ -111,6 +111,7 @@ jobs:
           #wget -qO ./docker-zip/AzzyBot/Modules/MusicStreaming/Files/plugins/java-lyrics-plugin-1.6.4.jar https://maven.lavalink.dev/releases/me/duncte123/java-lyrics-plugin/1.6.4/java-lyrics-plugin-1.6.4.jar
           mkdir -p ./docker-zip/AzzyBot/Settings
           mv ./AzzyBot-Next/Settings/AzzyBotSettings-Docker.json ./docker-zip/AzzyBot/Settings/AzzyBotSettings-Docker.json
+          mkdir -p ./docker-zip/AzzyBot/Logs
 
       - name: Archive docker-zip artifact
         uses: actions/upload-artifact@v4

.github/workflows/dotnet.yml

@@ -109,6 +109,7 @@ jobs:
          #wget -qO ./docker-zip/AzzyBot/Modules/MusicStreaming/Files/plugins/java-lyrics-plugin-1.6.4.jar https://maven.lavalink.dev/releases/me/duncte123/java-lyrics-plugin/1.6.4/java-lyrics-plugin-1.6.4.jar
          mkdir -p ./docker-zip/AzzyBot-Next/Settings
          mv ./AzzyBot-Next/Settings/AzzyBotSettings.json ./docker-zip/AzzyBot-Next/Settings/AzzyBotSettings.json
+         mkdir -p ./docker-zip/AzzyBot-Next/Logs
 
      - name: Archive docker-zip artifact
        uses: actions/upload-artifact@v4

.vscode/launch.json

@@ -11,7 +11,7 @@
             "preLaunchTask": "build-next",
             "program": "${workspaceFolder}/artifacts/bin/AzzyBot-Next/Debug/AzzyBot-Dev.dll",
             "args": [],
-            "cwd": "${workspaceFolder}/AzzyBot-Next",
+            "cwd": "${workspaceFolder}/artifacts/bin/AzzyBot-Next/Debug",
             "console": "externalTerminal",
             "stopAtEntry": false,
         },

AzzyBot-Next/Extensions/ServiceRegistering.cs

@@ -4,6 +4,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using AzzyBot.Database;
+using AzzyBot.Logging;
 using AzzyBot.Services;
 using AzzyBot.Services.Modules;
 using AzzyBot.Settings;
@@ -23,6 +24,11 @@ public static class ServiceRegistering
     public static void AzzyBotLogging(this ILoggingBuilder logging, bool isDev = false, bool forceDebug = false)
     {
         logging.AddConsole();
+
+        if (!Directory.Exists("Logs"))
+            Directory.CreateDirectory("Logs");
+
+        logging.AddFile("Logs");
         logging.AddFilter("Microsoft.EntityFrameworkCore.Database", (isDev || forceDebug) ? LogLevel.Debug : LogLevel.Warning);
         logging.AddFilter("Microsoft.EntityFrameworkCore.Database.Command", (isDev || forceDebug) ? LogLevel.Debug : LogLevel.Warning);
         logging.AddFilter("Microsoft.EntityFrameworkCore.Infrastructure", (isDev || forceDebug) ? LogLevel.Debug : LogLevel.Warning);

AzzyBot-Next/Logging/FileLogger.cs

@@ -0,0 +1,33 @@
+using System;
+using System.IO;
+using Microsoft.Extensions.Logging;
+
+namespace AzzyBot.Logging;
+
+public sealed class FileLogger(string directory) : ILogger, IDisposable
+{
+    private readonly string _directory = directory;
+    private readonly object _lock = new();
+
+    public IDisposable? BeginScope<TState>(TState state) where TState : notnull => default!;
+    public bool IsEnabled(LogLevel logLevel) => true;
+    private string GetLogFilePath() => Path.Combine(_directory, $"{DateTime.Now:yyyy-MM-dd}.log");
+
+    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
+    {
+        ArgumentNullException.ThrowIfNull(formatter, nameof(formatter));
+
+        if (!IsEnabled(logLevel) || string.IsNullOrWhiteSpace(formatter(state, exception)))
+            return;
+
+        lock (_lock)
+        {
+            string message = formatter(state, exception);
+            string logMessage = $"{DateTime.Now:yyyy-MM-dd HH:mm:ss} [{logLevel}] {message}{Environment.NewLine}";
+
+            File.AppendAllText(GetLogFilePath(), logMessage);
+        }
+    }
+
+    public void Dispose() { }
+}

AzzyBot-Next/Logging/FileLoggerProvider.cs

@@ -0,0 +1,27 @@
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using Microsoft.Extensions.Logging;
+
+namespace AzzyBot.Logging;
+
+public sealed class FileLoggerProvider(string directory) : ILoggerProvider
+{
+    private readonly string _directory = directory;
+    private readonly ConcurrentDictionary<string, FileLogger> _loggers = new();
+
+    public ILogger CreateLogger(string categoryName) => _loggers.GetOrAdd(categoryName, name => new FileLogger(_directory));
+    public void Dispose() => Dispose(true);
+
+    public void Dispose(bool disposing)
+    {
+        if (!disposing)
+            return;
+
+        foreach (KeyValuePair<string, FileLogger> logger in _loggers)
+        {
+            logger.Value.Dispose();
+        }
+
+        _loggers.Clear();
+    }
+}

AzzyBot-Next/Logging/LoggingBuilderExtensions.cs

@@ -0,0 +1,18 @@
+using System;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Logging;
+
+namespace AzzyBot.Logging;
+
+public static class LoggingBuilderExtensions
+{
+    public static ILoggingBuilder AddFile(this ILoggingBuilder builder, string directory)
+    {
+        ArgumentNullException.ThrowIfNull(builder, nameof(builder));
+
+        builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, FileLoggerProvider>(p => new FileLoggerProvider(directory)));
+
+        return builder;
+    }
+}