✨ feat(Logging): 增加用户和租户信息的日志记录

- 在 LogContext 中添加 TenantId 和 SessionId 属性
- 在 AspNetCoreLogContextAccessor 中获取当前用户信息并设置到 LogContext
- 在 LogContextEnricher 中添加 SessionId 和 TenantId 的日志 enricher
- 更新 LogModule 中的 Exceptionless 配置

Author: jianxuanbing

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

@@ -2,6 +2,7 @@
 using Bing.DependencyInjection;
 using Bing.Logging;
 using Bing.Tracing;
+using Bing.Users;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
 using Microsoft.Extensions.DependencyInjection;
@@ -24,17 +25,25 @@ public class AspNetCoreLogContextAccessor : LogContextAccessor
     /// </summary>
     protected IWebClientInfoProvider WebClientInfoProvider { get; }
 
+    /// <summary>
+    /// 当前用户
+    /// </summary>
+    protected ICurrentUser CurrentUser { get; }
+
     /// <summary>
     /// 初始化一个<see cref="AspNetCoreLogContextAccessor"/>类型的实例
     /// </summary>
     /// <param name="webClientInfoProvider">Web客户端信息提供程序</param>
     /// <param name="httpContextAccessor">Http上下文访问器</param>
+    /// <param name="currentUser">当前用户</param>
     public AspNetCoreLogContextAccessor(
         IHttpContextAccessor httpContextAccessor,
-        IWebClientInfoProvider webClientInfoProvider)
+        IWebClientInfoProvider webClientInfoProvider,
+        ICurrentUser currentUser)
     {
         HttpContextAccessor = httpContextAccessor;
         WebClientInfoProvider = webClientInfoProvider;
+        CurrentUser = currentUser;
     }
 
     /// <summary>
@@ -47,6 +56,13 @@ protected override LogContext Create()
         context.Browser = WebClientInfoProvider.ClientIpAddress;
         context.Url = HttpContextAccessor.HttpContext?.Request?.GetDisplayUrl();
         context.IsWebEnv = HttpContextAccessor.HttpContext?.Request != null;
+        context.UserId = CurrentUser.UserId;
+        context.TenantId = CurrentUser.TenantId;
+        context.Application = CurrentUser.GetApplicationName();
+        context.Data["UserName"] = CurrentUser.GetUserName();
+        context.Data["FullName"] = CurrentUser.GetFullName();
+        context.Data["TenantCode"] = CurrentUser.GetTenantCode();
+        context.Data["TenantName"] = CurrentUser.GetTenantName();
         if (!context.IsWebEnv)
             context.TraceId = base.GetTraceId();
         return context;

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

@@ -31,7 +31,9 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
             return;
         //RemoveProperties(logEvent);
         AddTraceId(logEvent, propertyFactory);
+        AddSessionId(logEvent, propertyFactory);
         AddUserId(logEvent, propertyFactory);
+        AddTenantId(logEvent, propertyFactory);
         AddApplication(logEvent, propertyFactory);
         AddEnvironment(logEvent, propertyFactory);
         AddExtraData(logEvent, propertyFactory);
@@ -56,7 +58,7 @@ private void RemoveProperties(LogEvent logEvent)
     private void AddTraceId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
     {
         var traceId = _context.TraceId;
-        if (!_context.IsWebEnv) 
+        if (!_context.IsWebEnv)
             traceId = TraceIdContext.Current?.TraceId;
         if (string.IsNullOrWhiteSpace(traceId))
             return;
@@ -65,6 +67,17 @@ private void AddTraceId(LogEvent logEvent, ILogEventPropertyFactory propertyFact
         logEvent.AddOrUpdateProperty(property);
     }
 
+    /// <summary>
+    /// 添加会话标识
+    /// </summary>
+    private void AddSessionId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+    {
+        if (string.IsNullOrWhiteSpace(_context.SessionId))
+            return;
+        var property = propertyFactory.CreateProperty("SessionId", _context.SessionId);
+        logEvent.AddOrUpdateProperty(property);
+    }
+
     /// <summary>
     /// 添加用户标识
     /// </summary>
@@ -76,6 +89,17 @@ private void AddUserId(LogEvent logEvent, ILogEventPropertyFactory propertyFacto
         logEvent.AddOrUpdateProperty(property);
     }
 
+    /// <summary>
+    /// 添加租户标识
+    /// </summary>
+    private void AddTenantId(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+    {
+        if (string.IsNullOrWhiteSpace(_context.TenantId))
+            return;
+        var property = propertyFactory.CreateProperty("TenantId", _context.UserId);
+        logEvent.AddOrUpdateProperty(property);
+    }
+
     /// <summary>
     /// 添加应用程序
     /// </summary>
@@ -107,6 +131,8 @@ private void AddExtraData(LogEvent logEvent, ILogEventPropertyFactory propertyFa
             return;
         foreach (var item in _context.Data)
         {
+            if (item.Value == null)
+                continue;
             var property = propertyFactory.CreateProperty(item.Key, item.Value);
             logEvent.AddOrUpdateProperty(property);
         }

framework/src/Bing.Logging/Bing/Logging/LogContext.cs

@@ -20,6 +20,11 @@ public class LogContext
     /// </summary>
     public string UserId { get; set; }
 
+    /// <summary>
+    /// 租户标识
+    /// </summary>
+    public string TenantId { get; set; }
+
     /// <summary>
     /// 应用程序
     /// </summary>
@@ -50,6 +55,11 @@ public class LogContext
     /// </summary>
     public string Url { get; set; }
 
+    /// <summary>
+    /// 会话标识
+    /// </summary>
+    public string SessionId { get; set; }
+
     /// <summary>
     /// 是否Web环境
     /// </summary>

modules/admin/src/Bing.Admin/Modules/LogModule.cs

@@ -47,7 +47,7 @@ public override IServiceCollection AddServices(IServiceCollection services)
             //ExceptionlessClient.Default.Startup();
             services.AddExceptionless(x =>
             {
-                x.ApiKey = "vCFssLV6HPlElQ6wkQJaLvaCqvhTTsWWTOm8dzQo";
+                x.ApiKey = "aUBmHcfhK8VvPLqsTYvVOeXJYY4jN5QghOY68FZe";
                 x.ServerUrl = "http://10.186.135.147:5100";
             });
             services.AddLogging(loggingBuilder =>

tests/Bing.Tests.Samples/Bing/Tests/Samples/AggregateRootSample.cs

@@ -178,6 +178,11 @@ protected override void AddChanges(AggregateRootSample newObj)
         AddChange(IntSamples,newObj.IntSamples);
     }
 
+    /// <summary>
+    /// 获取名称
+    /// </summary>
+    public string GetName() => "c";
+
     /// <summary>
     /// 创建测试样例
     /// </summary>
@@ -223,4 +228,4 @@ public class AggregateRootSample2 : AggregateRoot<AggregateRootSample>
     public AggregateRootSample2(Guid id) : base(id)
     {
     }
-}
+}