.NET 中 Logger 常被忽视的方法 BeginScope

BeginScope 方法是 .NET 中 ILogger 接口的一部分，用于创建日志记录的作用域（Scope）。这种作用域可以将特定的上下文信息包含在日志中，从而进步日志的可读性和调试效率。
配置日志包含作用域信息

首先，需要在日志配置中启用包含作用域信息。以 appsettings.json 为例，以下是配置示例：

1. {
2.   "Logging": {
3.     "Console": {
4.       "IncludeScopes": true,
5.       "LogLevel": {
6.         "Default": "Information",
7.         "Microsoft.AspNetCore": "Warning"
8.       }
9.     }
10.   }
11. }

复制代码

在该配置中，IncludeScopes 被设置为 true，这意味着在控制台日志中将包含作用域信息。
在代码中利用 BeginScope

利用 BeginScope 方法在日志中添加上下文信息，如下代码手动显示：

1. [HttpGet(Name = "Get")]
2. public string Get()
3. {
4.     using (_logger.BeginScope("TenantName {TenantName}", "test"))
5.     {
6.         _logger.LogInformation("这是一条测试日志信息");
7.     }
9.     return "ok";
10. }

复制代码

在这段代码中，我们利用 BeginScope 创建了一个作用域，并设置了一个上下文变量。在这个作用域之内，日志信息将包含这个上下文变量。

 
将作用域信息 JSON化

通过实现自己的 ILogger 接口，我们可以将作用域信息以 JSON 格式输出：

1. public class ScopeLogger : ILogger
2. {
3.     private readonly string _categoryName;
4.     private static readonly AsyncLocal<Stack<object>> _scopeStack = new AsyncLocal<Stack<object>>();
6.     public ScopeLogger(string categoryName)
7.     {
8.         _categoryName = categoryName;
9.     }
11.     public IDisposable BeginScope<TState>(TState state) where TState : notnull
12.     {
13.         if (_scopeStack.Value == null)
14.         {
15.             _scopeStack.Value = new Stack<object>();
16.         }
17.         _scopeStack.Value.Push(state);
19.         return new Scope(() => _scopeStack.Value.Pop());
20.     }
22.     public bool IsEnabled(LogLevel logLevel) => true;
24.     public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
25.     {
26.         var logEntry = new Dictionary<string, object>
27.         {
28.             ["Timestamp"] = DateTime.UtcNow,
29.             ["LogLevel"] = logLevel.ToString(),
30.             ["Category"] = _categoryName,
31.             ["Message"] = formatter(state, exception),
32.             ["Exception"] = exception?.ToString()
33.         };
35.         if (_scopeStack.Value != null && _scopeStack.Value.Count > 0)
36.         {
37.             var scopes = new List<object>();
38.             foreach (var scope in _scopeStack.Value)
39.             {
40.                 scopes.Add(scope);
41.             }
42.             logEntry["Scopes"] = scopes;
43.         }
45.         var json = JsonSerializer.Serialize(logEntry, new JsonSerializerOptions { WriteIndented = true });
46.         Console.WriteLine(json);
47.     }
49.     private class Scope : IDisposable
50.     {
51.         private readonly Action _onDispose;
53.         public Scope(Action onDispose)
54.         {
55.             _onDispose = onDispose;
56.         }
58.         public void Dispose()
59.         {
60.             _onDispose?.Invoke();
61.         }
62.     }
63. }
65. public class ScopeLoggerProvider : ILoggerProvider
66. {
67.     public ILogger CreateLogger(string categoryName)
68.     {
69.         return new ScopeLogger(categoryName);
70.     }
72.     public void Dispose() { }
73. }
75. builder.Logging.ClearProviders();
76. builder.Logging.AddProvider(new ScopeLoggerProvider());

复制代码

上面的代码创建了自己的 ILogger 实现，并将作用域信息以 JSON 格式输出。

 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。