feat(logger): 添加 MongoDB 日志存储支持和日志输出模板配置

AlianBlank · AlianBlank · commit d17c554ca01d · 2025-11-02T23:47:40.000+08:00
添加 Serilog.Sinks.MongoDB 依赖支持将日志写入 MongoDB
新增 LogOptions 配置项：IsWriteToMongoDb、DatabaseUrl、CappedMaxSizeMb、CappedMaxDocuments
支持自定义控制台和文件日志输出模板格式
优化日志输出显示方式，使用 LogHelper.ShowOption 替代直接 Console.WriteLine
diff --git a/GameFrameX.Foundation.Logger/GameFrameX.Foundation.Logger.csproj b/GameFrameX.Foundation.Logger/GameFrameX.Foundation.Logger.csproj
@@ -50,9 +50,11 @@
       <PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
         <PackageReference Include="Serilog.Sinks.File" Version="7.0.0"/>
         <PackageReference Include="Serilog.Sinks.Grafana.Loki" Version="8.3.1" />
+        <PackageReference Include="Serilog.Sinks.MongoDB" Version="7.2.0" />
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\GameFrameX.Foundation.Extensions\GameFrameX.Foundation.Extensions.csproj" />
       <ProjectReference Include="..\GameFrameX.Foundation.Json\GameFrameX.Foundation.Json.csproj" />
     </ItemGroup>
 
diff --git a/GameFrameX.Foundation.Logger/LogHandler.cs b/GameFrameX.Foundation.Logger/LogHandler.cs
@@ -5,6 +5,7 @@
 // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
 
 using System.IO.Compression;
+using GameFrameX.Foundation.Extensions;
 using Serilog;
 using Serilog.Events;
 using Serilog.Sinks.Grafana.Loki;
@@ -79,18 +80,24 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
                 Directory.CreateDirectory(logFolderPath);
             }
 
-            Console.WriteLine("the following is the log configuration information");
-            Console.WriteLine("╔═════════════════════════════════════════════════════════╗");
-            Console.WriteLine(logOptions);
-            Console.WriteLine("╚═════════════════════════════════════════════════════════╝");
+
+            // Console.WriteLine("the following is the log configuration information");
+            if (isDefault)
+            {
+                LogHelper.ShowOption("log configuration information", logOptions);
+            }
+
+            // Console.WriteLine("╔═════════════════════════════════════════════════════════╗");
+            // Console.WriteLine(logOptions);
+            // Console.WriteLine("╚═════════════════════════════════════════════════════════╝");
             Console.WriteLine();
             var logger = CreateLoggerConfiguration().Enrich.WithProperty("AppType", logOptions.LogType ?? AppDomain.CurrentDomain.FriendlyName);
             if (!string.IsNullOrEmpty(logOptions.LogTagName))
             {
                 logger.Enrich.WithProperty("TagName", logOptions.LogTagName ?? "");
             }
 
-            logger.WriteTo.File(logPath, rollingInterval: logOptions.RollingInterval, rollOnFileSizeLimit: logOptions.IsFileSizeLimit, fileSizeLimitBytes: logOptions.FileSizeLimitBytes, retainedFileCountLimit: logOptions.RetainedFileCountLimit);
+
             if (logOptions.IsGrafanaLoki)
             {
                 var grafanaLokiLabels = new List<LokiLabel>();
@@ -149,6 +156,31 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
             }
 
             configurationAction?.Invoke(logger);
+
+            string consoleOutputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}][{TagName}]{Message:lj}{NewLine}{Exception}";
+            string fileOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{FriendlyName}] {Message:lj}{NewLine}{Exception}";
+
+            if (logOptions.ConsoleOutputTemplate.IsNotNullOrEmptyOrWhiteSpace())
+            {
+                consoleOutputTemplate = logOptions.ConsoleOutputTemplate;
+            }
+
+            if (logOptions.FileOutputTemplate.IsNotNullOrEmptyOrWhiteSpace())
+            {
+                fileOutputTemplate = logOptions.FileOutputTemplate;
+            }
+            if (logOptions.IsWriteToFile)
+            {
+                logger.WriteTo.File(logPath,
+                                    shared: true,
+                                    restrictedToMinimumLevel: logOptions.LogEventLevel,
+                                    outputTemplate: fileOutputTemplate,
+                                    rollingInterval: logOptions.RollingInterval,
+                                    rollOnFileSizeLimit: logOptions.FileSizeLimitBytes > 0,
+                                    fileSizeLimitBytes: logOptions.FileSizeLimitBytes
+                );
+            }
+
             switch (logOptions.LogEventLevel)
             {
                 case LogEventLevel.Verbose:
@@ -185,7 +217,9 @@ public static ILogger Create(LogOptions logOptions, bool isDefault = true, Actio
 
             if (logOptions.IsConsole)
             {
-                logger.WriteTo.Console();
+                logger.WriteTo.Console(outputTemplate: consoleOutputTemplate,
+                                       restrictedToMinimumLevel: logOptions.LogEventLevel,
+                                       theme: Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate);
             }
 
             var serilog = logger.CreateLogger();
diff --git a/GameFrameX.Foundation.Logger/LogOptions.cs b/GameFrameX.Foundation.Logger/LogOptions.cs
@@ -34,6 +34,11 @@ public LogOptions(string logPathName = "logs")
     /// </remarks>
     public static readonly LogOptions Default = new LogOptions();
 
+    /// <summary>
+    /// 是否写入文件，默认为 true。
+    /// </summary>
+    public bool IsWriteToFile { get; set; } = true;
+
     /// <summary>
     /// 服务器类型，用于标识日志来源的服务器类型。
     /// </summary>
@@ -50,6 +55,29 @@ public LogOptions(string logPathName = "logs")
     /// </remarks>
     public string LogTagName { get; set; } = "";
 
+    /// <summary>
+    /// 是否写入数据库，默认为 false。
+    /// </summary>
+    public bool IsWriteToMongoDb { get; set; } = false;
+
+    /// <summary>
+    /// mongodb 地址 用于保存日志
+    /// </summary>
+    /// <remarks>
+    /// 如果配置了Type = Db 必须要配置 databaseUrl
+    /// </remarks>
+    public string DatabaseUrl { get; set; } = "mongodb://127.0.0.1:27017/gameserver?authSource=admin";
+
+    /// <summary>
+    /// mongodb 创建的上限集合的最大总大小（MB）
+    /// </summary>
+    public int CappedMaxSizeMb { get; set; } = 50;
+
+    /// <summary>
+    /// mongodb 创建的上限集合的最大文档数。
+    /// </summary>
+    public int CappedMaxDocuments { get; set; } = 50000;
+
     /// <summary>
     /// 日志存储路径，为 应用程序运行目录下的子目录/logs。
     /// </summary>
@@ -146,6 +174,35 @@ public LogOptions(string logPathName = "logs")
     /// </remarks>
     public int? RetainedFileCountLimit { get; set; } = 31;
 
+
+    /// <summary>
+    /// 控制台日志输出格式模板，默认格式为 "[时:分:秒 级别][标签名]消息内容"。
+    /// </summary>
+    /// <remarks>
+    /// 支持的占位符包括：
+    /// - {Timestamp:HH:mm:ss} - 时间戳（时:分:秒格式）
+    /// - {Level:u3} - 日志级别（3个字符大写）
+    /// - {TagName} - 日志标签名称
+    /// - {Message:lj} - 日志消息内容（左对齐）
+    /// - {NewLine} - 换行符
+    /// - {Exception} - 异常信息
+    /// </remarks>
+    public string ConsoleOutputTemplate { get; set; } = "[{Timestamp:HH:mm:ss} {Level:u3}][{TagName}]{Message:lj}{NewLine}{Exception}";
+
+    /// <summary>
+    /// 文件日志输出格式模板，默认格式为 "完整时间戳 [级别][友好名称] 消息内容"。
+    /// </summary>
+    /// <remarks>
+    /// 支持的占位符包括：
+    /// - {Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} - 完整时间戳（包含毫秒和时区）
+    /// - {Level:u3} - 日志级别（3个字符大写）
+    /// - {FriendlyName} - 友好名称
+    /// - {Message:lj} - 日志消息内容（左对齐）
+    /// - {NewLine} - 换行符
+    /// - {Exception} - 异常信息
+    /// </remarks>
+    public string FileOutputTemplate { get; set; } = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}][{FriendlyName}] {Message:lj}{NewLine}{Exception}";
+
     /// <summary>
     /// 返回日志配置对象的 JSON 字符串表示形式。
     /// </summary>
