feat: 新增 Serilog 日志输出模块

Author: jianxuanbing

Bing.All.sln

@@ -228,9 +228,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Test.Shared", "framewo
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Ddd.Domain.Tests", "framework\tests\Bing.Ddd.Domain.Tests\Bing.Ddd.Domain.Tests.csproj", "{8B581529-D7D2-4DCF-824A-2AAFB58F8C94}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bing.Logging", "framework\src\Bing.Logging\Bing.Logging.csproj", "{ECB340A3-A21C-460D-8EBC-09EA5FB8731C}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Logging", "framework\src\Bing.Logging\Bing.Logging.csproj", "{ECB340A3-A21C-460D-8EBC-09EA5FB8731C}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bing.Logging.Sinks.Exceptionless", "framework\src\Bing.Logging.Sinks.Exceptionless\Bing.Logging.Sinks.Exceptionless.csproj", "{04EB5533-6885-4292-BED1-4D06A5E162D1}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bing.Logging.Sinks.Exceptionless", "framework\src\Bing.Logging.Sinks.Exceptionless\Bing.Logging.Sinks.Exceptionless.csproj", "{04EB5533-6885-4292-BED1-4D06A5E162D1}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bing.Logging.Serilog", "framework\src\Bing.Logging.Serilog\Bing.Logging.Serilog.csproj", "{9E817B3A-BA88-42A4-A7D7-C4C935889BC5}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -522,6 +524,10 @@ Global
 		{04EB5533-6885-4292-BED1-4D06A5E162D1}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{04EB5533-6885-4292-BED1-4D06A5E162D1}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{04EB5533-6885-4292-BED1-4D06A5E162D1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9E817B3A-BA88-42A4-A7D7-C4C935889BC5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9E817B3A-BA88-42A4-A7D7-C4C935889BC5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9E817B3A-BA88-42A4-A7D7-C4C935889BC5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9E817B3A-BA88-42A4-A7D7-C4C935889BC5}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -624,6 +630,7 @@ Global
 		{8B581529-D7D2-4DCF-824A-2AAFB58F8C94} = {5C7976B4-C243-41B9-8303-8E8FAE099D31}
 		{ECB340A3-A21C-460D-8EBC-09EA5FB8731C} = {33F6CAB3-FD8A-4B91-9B94-A1E2DBC2759B}
 		{04EB5533-6885-4292-BED1-4D06A5E162D1} = {33F6CAB3-FD8A-4B91-9B94-A1E2DBC2759B}
+		{9E817B3A-BA88-42A4-A7D7-C4C935889BC5} = {33F6CAB3-FD8A-4B91-9B94-A1E2DBC2759B}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {C1202A0F-83CC-4602-BCE5-20CB640BCAD4}

framework/src/Bing.Logging.Serilog/Bing.Logging.Serilog.csproj

@@ -0,0 +1,8 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="project.props" />
+
+  <Import Project="project.dependency.props" />
+
+  <Import Project="..\..\..\framework.props" />
+
+</Project>

framework/src/Bing.Logging.Serilog/Bing/Logging/Serilog/Enrichers/LogContextEnricher.cs

@@ -0,0 +1,132 @@
+using Bing.Extensions;
+using Serilog.Core;
+using Serilog.Events;
+
+namespace Bing.Logging.Serilog.Enrichers
+{
+    /// <summary>
+    /// 日志上下文扩展属性
+    /// </summary>
+    public class LogContextEnricher : ILogEventEnricher
+    {
+        /// <summary>
+        /// 日志上下文
+        /// </summary>
+        private LogContext _context;
+
+        /// <summary>
+        /// 日志上下文访问器
+        /// </summary>
+        private readonly ILogContextAccessor _logContextAccessor;
+
+        /// <summary>
+        /// 初始化一个 <see cref="LogContextEnricher"/>类型的实例
+        /// </summary>
+        /// <param name="logContextAccessor">日志上下文访问器</param>
+        public LogContextEnricher(ILogContextAccessor logContextAccessor)
+        {
+            _logContextAccessor = logContextAccessor;
+        }
+
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        /// <param name="logEvent">日志事件</param>
+        /// <param name="propertyFactory">日志事件属性工厂</param>
+        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (_logContextAccessor == null)
+                return;
+            _context = _logContextAccessor.Context;
+            if (_context == null)
+                return;
+            AddDuration(logEvent, propertyFactory);
+            AddTraceId(logEvent, propertyFactory);
+            AddUserId(logEvent, propertyFactory);
+            AddApplication(logEvent, propertyFactory);
+            AddEnvironment(logEvent, propertyFactory);
+            AddExtraData(logEvent, propertyFactory);
+        }
+
+        /// <summary>
+        /// 移除默认设置的部分属性
+        /// </summary>
+        private void RemoveProperties(LogEvent logEvent)
+        {
+            logEvent.RemovePropertyIfPresent("ActionId");
+            logEvent.RemovePropertyIfPresent("ActionName");
+            logEvent.RemovePropertyIfPresent("RequestId");
+            logEvent.RemovePropertyIfPresent("RequestPath");
+            logEvent.RemovePropertyIfPresent("ConnectionId");
+        }
+
+        /// <summary>
+        /// 添加执行持续时间
+        /// </summary>
+        private void AddDuration(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (_context.Stopwatch == null)
+                return;
+            var property = propertyFactory.CreateProperty("Duration", _context.Stopwatch.Elapsed.Description());
+            logEvent.AddOrUpdateProperty(property);
+        }
+
+        /// <summary>
+        /// 添加跟踪号
+        /// </summary>
+        private void AddTraceId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (string.IsNullOrWhiteSpace(_context.TraceId))
+                return;
+            var property = propertyFactory.CreateProperty("TraceId", _context.TraceId);
+            logEvent.AddOrUpdateProperty(property);
+        }
+
+        /// <summary>
+        /// 添加用户标识
+        /// </summary>
+        private void AddUserId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (string.IsNullOrWhiteSpace(_context.UserId))
+                return;
+            var property = propertyFactory.CreateProperty("UserId", _context.UserId);
+            logEvent.AddOrUpdateProperty(property);
+        }
+
+        /// <summary>
+        /// 添加应用程序
+        /// </summary>
+        private void AddApplication(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (string.IsNullOrWhiteSpace(_context.Application))
+                return;
+            var property = propertyFactory.CreateProperty("Application", _context.Application);
+            logEvent.AddOrUpdateProperty(property);
+        }
+
+        /// <summary>
+        /// 添加执行环境
+        /// </summary>
+        private void AddEnvironment(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (string.IsNullOrWhiteSpace(_context.Environment))
+                return;
+            var property = propertyFactory.CreateProperty("Environment", _context.Environment);
+            logEvent.AddOrUpdateProperty(property);
+        }
+
+        /// <summary>
+        /// 添加扩展数据
+        /// </summary>
+        private void AddExtraData(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            if (_context.Data.Count == 0)
+                return;
+            foreach (var item in _context.Data)
+            {
+                var property = propertyFactory.CreateProperty(item.Key, item.Value);
+                logEvent.AddOrUpdateProperty(property);
+            }
+        }
+    }
+}

framework/src/Bing.Logging.Serilog/Bing/Logging/Serilog/Enrichers/LogLevelEnricher.cs

@@ -0,0 +1,23 @@
+using Bing.Logging.Serilog.Internals;
+using Serilog.Core;
+using Serilog.Events;
+
+namespace Bing.Logging.Serilog.Enrichers
+{
+    /// <summary>
+    /// 日志级别扩展属性 - 用于显示标准日志级别
+    /// </summary>
+    public class LogLevelEnricher : ILogEventEnricher
+    {
+        /// <summary>
+        /// 扩展属性
+        /// </summary>
+        /// <param name="logEvent">日志事件</param>
+        /// <param name="propertyFactory">日志事件属性工厂</param>
+        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+        {
+            var property = propertyFactory.CreateProperty("LogLevel", LogLevelSwitcher.Switch(logEvent.Level));
+            logEvent.AddOrUpdateProperty(property);
+        }
+    }
+}

framework/src/Bing.Logging.Serilog/Bing/Logging/Serilog/Internals/LogLevelSwitcher.cs

@@ -0,0 +1,49 @@
+using Serilog.Events;
+
+namespace Bing.Logging.Serilog.Internals
+{
+    /// <summary>
+    /// 日志级别切换器
+    /// </summary>
+    internal static class LogLevelSwitcher
+    {
+        /// <summary>
+        /// 转换日志级别
+        /// </summary>
+        /// <param name="level">Serilog日志级别</param>
+        /// <returns>MS日志级别</returns>
+        public static string Switch(LogEventLevel level)
+        {
+            return level switch
+            {
+                LogEventLevel.Verbose => "Trace",
+                LogEventLevel.Debug => "Debug",
+                LogEventLevel.Information => "Information",
+                LogEventLevel.Warning => "Warning",
+                LogEventLevel.Error => "Error",
+                LogEventLevel.Fatal => "Critical",
+                _ => null
+            };
+        }
+
+        /// <summary>
+        /// 转换日志级别
+        /// </summary>
+        /// <param name="level">MS日志级别</param>
+        /// <returns>Serilog日志级别</returns>
+        public static LogEventLevel Switch(string level)
+        {
+            return level.ToUpperInvariant() switch
+            {
+                "TRACE" => LogEventLevel.Verbose,
+                "DEBUG" => LogEventLevel.Debug,
+                "INFORMATION" => LogEventLevel.Information,
+                "WARNING" => LogEventLevel.Warning,
+                "ERROR" => LogEventLevel.Error,
+                "CRITICAL" => LogEventLevel.Fatal,
+                "NONE" => LogEventLevel.Fatal,
+                _ => LogEventLevel.Warning
+            };
+        }
+    }
+}

framework/src/Bing.Logging.Serilog/Bing/Logging/Serilog/LoggerConfigurationExtensions.cs

@@ -0,0 +1,38 @@
+using System;
+using Bing.Logging.Serilog.Internals;
+using Microsoft.Extensions.Configuration;
+using Serilog;
+using Serilog.Core;
+
+namespace Bing.Logging.Serilog
+{
+    /// <summary>
+    /// Serilog日志配置操作(<see cref="LoggerConfiguration"/>) 扩展
+    /// </summary>
+    public static class LoggerConfigurationExtensions
+    {
+        /// <summary>
+        /// 配置日志级别
+        /// </summary>
+        /// <param name="source">Serilog日志配置</param>
+        /// <param name="configuration">配置</param>
+        public static LoggerConfiguration ConfigLogLevel(this LoggerConfiguration source, IConfiguration configuration)
+        {
+            if (source == null)
+                throw new ArgumentNullException(nameof(source));
+            if (configuration == null)
+                throw new ArgumentNullException(nameof(configuration));
+            var section = configuration.GetSection("Logging:LogLevel");
+            foreach (var item in section.GetChildren())
+            {
+                if (item.Key == "Default")
+                {
+                    source.MinimumLevel.ControlledBy(new LoggingLevelSwitch(LogLevelSwitcher.Switch(item.Value)));
+                    continue;
+                }
+                source.MinimumLevel.Override(item.Key, LogLevelSwitcher.Switch(item.Value));
+            }
+            return source;
+        }
+    }
+}

framework/src/Bing.Logging.Serilog/Bing/Logging/Serilog/LoggerEnrichmentConfigurationExtensions.cs

@@ -0,0 +1,40 @@
+using System;
+using Bing.Logging.Serilog.Enrichers;
+using Microsoft.Extensions.DependencyInjection;
+using Serilog;
+using Serilog.Configuration;
+
+namespace Bing.Logging.Serilog
+{
+    /// <summary>
+    /// Serilog扩展属性配置(<see cref="LoggerEnrichmentConfiguration"/>) 扩展
+    /// </summary>
+    public static class LoggerEnrichmentConfigurationExtensions
+    {
+        /// <summary>
+        /// 添加日志上下文扩展属性
+        /// </summary>
+        /// <param name="source">日志扩展配置</param>
+        /// <param name="serviceProvider">服务提供程序</param>
+        public static LoggerConfiguration WithLogContext(this LoggerEnrichmentConfiguration source, IServiceProvider serviceProvider)
+        {
+            if (source == null)
+                throw new ArgumentNullException(nameof(source));
+            if (serviceProvider == null)
+                throw new ArgumentNullException(nameof(serviceProvider));
+            var enricher = serviceProvider.GetRequiredService<LogContextEnricher>();
+            return source.With(enricher);
+        }
+
+        /// <summary>
+        /// 添加日志级别扩展属性
+        /// </summary>
+        /// <param name="source">日志扩展配置</param>
+        public static LoggerConfiguration WithLogLevel(this LoggerEnrichmentConfiguration source)
+        {
+            if (source == null)
+                throw new ArgumentNullException(nameof(source));
+            return source.With<LogLevelEnricher>();
+        }
+    }
+}

framework/src/Bing.Logging.Serilog/project.dependency.props

@@ -0,0 +1,13 @@
+<Project>
+  <ItemGroup>
+    <ProjectReference Include="..\Bing.Logging\Bing.Logging.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Serilog.Extensions.Logging" Version="3.1.0" />
+    <PackageReference Include="Serilog.Settings.Configuration" Version="3.3.0" />
+    <PackageReference Include="Serilog.Sinks.File" Version="5.0.0" />
+    <PackageReference Include="Serilog.Sinks.Seq" Version="5.1.0" />
+  </ItemGroup>
+
+</Project>

framework/src/Bing.Logging.Serilog/project.props

@@ -0,0 +1,8 @@
+<Project>
+  <PropertyGroup>
+    <AssemblyName>Bing.Logging.Serilog</AssemblyName>
+    <PackageId>Bing.Logging.Serilog</PackageId>
+    <Description>Bing.Logging.Serilog是Bing应用框架的集成封装Serilog日志框架的核心类库，它包含了写入文件和Seq。</Description>
+  </PropertyGroup>
+
+</Project>