fix: 优化日志跟踪ID信息

Author: jianxuanbing

framework/src/Bing.AspNetCore/Bing/AspNetCore/Logs/AspNetCoreLogContextAccessor.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Diagnostics;
+using Bing.AspNetCore.WebClientInfo;
+using Bing.DependencyInjection;
+using Bing.Logging;
+using Bing.Tracing;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Extensions;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Bing.AspNetCore.Logs
+{
+    /// <summary>
+    /// AspNetCore日志上下文访问器
+    /// </summary>
+    [Dependency(ServiceLifetime.Scoped, ReplaceExisting = true)]
+    public class AspNetCoreLogContextAccessor : LogContextAccessor
+    {
+        /// <summary>
+        /// Http上下文访问器
+        /// </summary>
+        protected IHttpContextAccessor HttpContextAccessor { get; }
+
+        /// <summary>
+        /// Web客户端信息提供程序
+        /// </summary>
+        protected IWebClientInfoProvider WebClientInfoProvider { get; }
+
+        /// <summary>
+        /// 初始化一个<see cref="AspNetCoreLogContextAccessor"/>类型的实例
+        /// </summary>
+        /// <param name="webClientInfoProvider">Web客户端信息提供程序</param>
+        /// <param name="httpContextAccessor">Http上下文访问器</param>
+        public AspNetCoreLogContextAccessor(
+            IHttpContextAccessor httpContextAccessor,
+            IWebClientInfoProvider webClientInfoProvider)
+        {
+            HttpContextAccessor = httpContextAccessor;
+            WebClientInfoProvider = webClientInfoProvider;
+        }
+
+        /// <summary>
+        /// 创建日志上下文
+        /// </summary>
+        protected override LogContext Create()
+        {
+            var context = base.Create();
+            context.Ip = WebClientInfoProvider.ClientIpAddress;
+            context.Browser = WebClientInfoProvider.ClientIpAddress;
+            context.Url = HttpContextAccessor.HttpContext?.Request?.GetDisplayUrl();
+            context.IsWebEnv = HttpContextAccessor.HttpContext?.Request != null;
+            if (!context.IsWebEnv)
+                context.TraceId = base.GetTraceId();
+            return context;
+        }
+
+        /// <summary>
+        /// 获取跟踪标识
+        /// </summary>
+        protected override string GetTraceId()
+        {
+            if (TraceIdContext.Current != null)
+                return TraceIdContext.Current.TraceId;
+            var correlationId = HttpContextAccessor.HttpContext?.Request.Headers["X-Correlation-Id"];
+            if (!string.IsNullOrWhiteSpace(correlationId))
+                return correlationId;
+            var traceId = HttpContextAccessor.HttpContext?.TraceIdentifier;
+            return string.IsNullOrWhiteSpace(traceId) ? Guid.NewGuid().ToString("N") : Guid.TryParse(traceId, out _) ? traceId : Guid.NewGuid().ToString("N");
+        }
+    }
+}

framework/src/Bing.AspNetCore/Bing/AspNetCore/Logs/SysLogger.cs

@@ -42,11 +42,11 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
             var message = formatter(state, exception);
             if (string.IsNullOrEmpty(message) && exception == null)
                 return;
-            var log = Bing.Logs.Log.GetLog(LogName);
+            var log = Bing.Logs.Log.GetLog(CategoryName);
             log
                 .Tag(LogName)
                 .Tag(CategoryName)
-                .Caption($"系统日志：{CategoryName}")
+                .Caption($"系统日志：{message}")
                 .Content($"事件ID：{eventId.Id}")
                 .Content($"事件名称：{eventId.Name}")
                 .Content(message);

framework/src/Bing.AspNetCore/project.dependency.props

@@ -9,6 +9,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\Bing.Logging\Bing.Logging.csproj" />
     <ProjectReference Include="..\Bing.Logs\Bing.Logs.csproj" />
     <ProjectReference Include="..\Bing\Bing.csproj" />
   </ItemGroup>

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

@@ -1,6 +1,7 @@
 using System.Linq;
 using Bing.DependencyInjection;
 using Bing.Extensions;
+using Bing.Tracing;
 using Serilog.Core;
 using Serilog.Events;
 
@@ -69,9 +70,12 @@ private void AddDuration(LogEvent logEvent, ILogEventPropertyFactory propertyFac
         /// </summary>
         private void AddTraceId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
         {
-            if (string.IsNullOrWhiteSpace(_context.TraceId))
+            var traceId = _context.TraceId;
+            if (!_context.IsWebEnv) 
+                traceId = TraceIdContext.Current?.TraceId;
+            if (string.IsNullOrWhiteSpace(traceId))
                 return;
-            var property = propertyFactory.CreateProperty("TraceId", _context.TraceId);
+            var property = propertyFactory.CreateProperty("TraceId", traceId);
             logEvent.AddOrUpdateProperty(property);
         }
 

framework/src/Bing.Logging/Bing/Logging/ILogContextAccessor.cs

@@ -8,6 +8,6 @@ public interface ILogContextAccessor
         /// <summary>
         /// 日志上下文
         /// </summary>
-        LogContext Context { get; set; }
+        LogContext Context { get; }
     }
 }

framework/src/Bing.Logging/Bing/Logging/ILoggerWrapper.cs

@@ -25,6 +25,16 @@ public interface ILoggerWrapper
         /// <param name="formatter">消息格式化操作</param>
         void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter);
 
+        /// <summary>
+        /// 写日志
+        /// </summary>
+        /// <param name="logLevel">日志级别</param>
+        /// <param name="eventId">日志事件标识</param>
+        /// <param name="exception">异常</param>
+        /// <param name="message">日志消息</param>
+        /// <param name="args">日志消息参数</param>
+        void Log(LogLevel logLevel, EventId eventId, Exception exception, string message, params object[] args);
+
         /// <summary>
         /// 开启日志范围
         /// </summary>

framework/src/Bing.Logging/Bing/Logging/Log.cs

@@ -209,168 +209,42 @@ public virtual ILog Message(string message, params object[] args)
         #region LogTrace(写跟踪日志)
 
         /// <inheritdoc />
-        public virtual ILog LogTrace([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogTrace(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Trace;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogTrace([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Trace, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
         #region LogDebug(写调试日志)
 
         /// <inheritdoc />
-        public virtual ILog LogDebug([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogDebug(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Debug;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogDebug([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Debug, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
         #region LogInformation(写信息日志)
 
         /// <inheritdoc />
-        public virtual ILog LogInformation([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                CurrentDescriptor.Context.SetCallerInfo(memberName, sourceFilePath, sourceLineNumber);
-                var scopeDict = CurrentDescriptor.Context.ExposeScopeState();
-                if (scopeDict.Any())
-                {
-                    using (Logger.BeginScope(scopeDict))
-                    {
-                        Init();
-                        if (LogMessage.Length > 0)
-                        {
-                            Logger.LogInformation(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                            return this;
-                        }
-
-                        LogLevel = LogLevel.Information;
-                        return WriteLog();
-                    }
-                }
-                Debug.WriteLine($"【调试日志】未进入作用域字典");
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogInformation(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Information;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogInformation([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Information, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
         #region LogWarning(写警告日志)
 
         /// <inheritdoc />
-        public virtual ILog LogWarning([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogWarning(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Warning;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogWarning([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Warning, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
         #region LogError(写错误日志)
 
         /// <inheritdoc />
-        public virtual ILog LogError([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogError(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Error;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogError([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Error, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
         #region LogCritical(写致命日志)
 
         /// <inheritdoc />
-        public virtual ILog LogCritical([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0)
-        {
-            try
-            {
-                Init();
-                if (LogMessage.Length > 0)
-                {
-                    Logger.LogCritical(LogEventId, LogException, GetMessage(), GetMessageArgs());
-                    return this;
-                }
-
-                LogLevel = LogLevel.Critical;
-                return WriteLog();
-            }
-            finally
-            {
-                Clear();
-            }
-        }
+        public virtual ILog LogCritical([CallerMemberName] string memberName = "", [CallerFilePath] string sourceFilePath = "", [CallerLineNumber] int sourceLineNumber = 0) => WriteLog(LogLevel.Critical, memberName, sourceFilePath, sourceLineNumber);
 
         #endregion
 
@@ -453,10 +327,34 @@ protected virtual object[] GetMessageArgs()
         /// <summary>
         /// 写日志
         /// </summary>
-        protected virtual ILog WriteLog()
+        /// <param name="level">日志级别</param>
+        /// <param name="memberName">方法名</param>
+        /// <param name="sourceFilePath">文件路径</param>
+        /// <param name="sourceLineNumber">行号</param>
+        protected virtual ILog WriteLog(LogLevel level, string memberName, string sourceFilePath, int sourceLineNumber)
         {
-            Logger.Log(LogLevel, LogEventId, GetContent(), LogException, GetFormatMessage);
-            return this;
+            try
+            {
+                LogLevel = level;
+                CurrentDescriptor.Context.SetCallerInfo(memberName, sourceFilePath, sourceLineNumber);
+                var scopeDict = CurrentDescriptor.Context.ExposeScopeState();
+                using (Logger.BeginScope(scopeDict))
+                {
+                    Init();
+                    if (LogMessage.Length > 0)
+                    {
+                        Logger.Log(level, LogEventId, LogException, GetMessage(), GetMessageArgs());
+                        return this;
+                    }
+
+                    Logger.Log(LogLevel, LogEventId, GetContent(), LogException, GetFormatMessage);
+                    return this;
+                }
+            }
+            finally
+            {
+                Clear();
+            }
         }
 
         /// <summary>