您现在的位置是:网站首页> 编程资料编程资料

.net core日志结构化_实用技巧_

2023-05-24 361人已围观

简介 .net core日志结构化_实用技巧_

前言

什么是结构化呢? 结构化,就是将原本没有规律的东西进行有规律话。

就比如我们学习数据结构,需要学习排序然后又要学习查询,说白了这就是一套,没有排序,谈如何查询是没有意义的,因为查询算法就是根据某种规律得到最佳的效果。

同样日志结构话,能够让我们得到一些好处。如果说容易检索,容易分析,总的来说就是让我们的日志更加有规律。

如果我们的日志结构化了,那么可以使用elasticsearch 这样的框架进行二次整理,再借助一些分析工具。

我们就能做到可视化分析系统的运行情况,做到日志告警、上下文关联、实现追踪系统集成,同样也易于检索相关信息。

说了这么多,其实对于程序员,就是为了节约排查错误的时间,然后在做系统稳定化方案的时候有依据,我们是讲道理的,做事要有依据,不能张口就来。

正文

这里结构化,借助需要借助serilog,引用serilog.aspnetcore。

开源地址如下:

https://github.com/serilog/serilog-aspnetcore

这里介绍一下简单的接入方式:

在CreateHostBuilder 中加入UseSerilog:

 public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup(); }).UseSerilog(dispose:true);

然后在Startup的ConfigureServices的加入:

 services.AddLogSeriLog(Configuration);

这个AddLogSeriLog 是我写的扩展:

 public static class SeriLogExtension { public static Serilog.ILogger AddLogSeriLog(this IServiceCollection services, IConfiguration configuration) { Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(configuration) .MinimumLevel.Debug() .Enrich.FromLogContext() .WriteTo.Console(new RenderedCompactJsonFormatter()) .WriteTo.File(formatter: new CompactJsonFormatter(), "logs\\test.txt", rollingInterval: RollingInterval.Day) .CreateLogger(); return Log.Logger; } }

输出:

这时候发现我们的输出都json化了。

同时在根目录下的logs目录下输出日志文件:

但是我们这样发现,日志太多了,我们需要过滤掉一些日志,那么我们可以配置:

 "Serilog": { "MinimumLevel": { "Default": "Information", "Override": { "Microsoft": "Error", "System": "Information" } } }

测试代码:

 [HttpGet] public int GetService([FromServices]ISelfService selfService) { _logger.LogInformation("Hello Word"); return 1; }

结果:

因为上面配置了Microsoft 为Error级别的,故而系统打印的日志只有Error基本才会输出。

这里面简单看一下Serilog 的原理,

因为//www.jb51.net/article/215119.htm已经介绍了日志系统的基本结果,故而直接往下续:

查看UseSerilog:

 public static IHostBuilder UseSerilog( this IHostBuilder builder, ILogger logger = null, bool dispose = false, LoggerProviderCollection providers = null) { if (builder == null) throw new ArgumentNullException(nameof (builder)); builder.ConfigureServices((Action) ((_, collection) => { if (providers != null) ServiceCollectionServiceExtensions.AddSingleton(collection, (Func) (services => { SerilogLoggerFactory serilogLoggerFactory = new SerilogLoggerFactory(logger, dispose, providers); foreach (ILoggerProvider service in (IEnumerable) ServiceProviderServiceExtensions.GetServices(services)) serilogLoggerFactory.AddProvider(service); return (ILoggerFactory) serilogLoggerFactory; })); else ServiceCollectionServiceExtensions.AddSingleton(collection, (Func) (services => (ILoggerFactory) new SerilogLoggerFactory(logger, dispose, (LoggerProviderCollection) null))); SerilogHostBuilderExtensions.ConfigureServices(collection, logger); })); return builder; }

这里我简单梳理一下日志系统的基本结构,首选是ILoggerFactory, 里面会有一个CreateLogger,创建一个ILogger。那么这个ILogger的作用是什么呢?

是用来统一接口的。 比如说我们有文件日志,有控制台日志,有很多方式输出日志。那么就要有一个管理的来统一接口。

而每一种打印方式,继承ILoggerProvider,比如ConsoleProvider继承ILoggerProvider有一个CreateLogger方法,这个CreateLog才是创建具体的实现类,比如说ConsoleLogger,ConsoleLogger又继承ILogger。

从而ILogger的另一个实现类Logger实现代理,管理其他继承ILogger的实现类。

可能我这样说有点模糊,那么请看完上面链接,应该就会明白我所以表达的意思。

那么回到上文中。

ServiceCollectionServiceExtensions.AddSingleton(collection, (Func) (services => (ILoggerFactory) new SerilogLoggerFactory(logger, dispose, (LoggerProviderCollection)

将我们的ILoggerFactory 替换成了SerilogLoggerFactory,官方是LoggerFactory。

那么看下SerilogLoggerFactory:

 public SerilogLoggerFactory( Serilog.ILogger logger = null, bool dispose = false, LoggerProviderCollection providerCollection = null) { this._provider = new SerilogLoggerProvider(logger, dispose); this._providerCollection = providerCollection; } /// Disposes the provider. public void Dispose() { this._provider.Dispose(); } ///  /// Creates a new  instance. ///  /// The category name for messages produced by the logger. ///  /// The . ///  public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName) { return this._provider.CreateLogger(categoryName); } ///  /// Adds an  to the logging system. ///  /// The . public void AddProvider(ILoggerProvider provider) { if (provider == null) throw new ArgumentNullException(nameof (provider)); if (this._providerCollection != null) this._providerCollection.AddProvider(provider); else SelfLog.WriteLine("Ignoring added logger provider {0}", (object) provider, (object) null, (object) null); } }

那么继续查看CreateLogger,SerilogLoggerProvider的CreateLogger 及其相关:

 private readonly Serilog.ILogger _logger; public SerilogLoggerProvider(Serilog.ILogger logger = null, bool dispose = false) { if (logger != null) this._logger = logger.ForContext((IEnumerable) new SerilogLoggerProvider[1] { this }); if (!dispose) return; if (logger != null) this._dispose = (Action) (() => { if (!(logger is IDisposable disposable)) return; disposable.Dispose(); }); else this._dispose = new Action(Log.CloseAndFlush); } public Microsoft.Extensions.Logging.ILogger CreateLogger(string name) { return (Microsoft.Extensions.Logging.ILogger) new SerilogLogger(this, this._logger, name); }

而SerilogLogger 就是具体来管理全部继承ILogger具体的实现的类。 那么是否是和官方一样,其他实现类都是继承自ILogger的呢?答案不是,他们都继承自ILogEventSink,下面会继续提及,暂时不要关心这个。

同时要忘记官方每个实现具体打印的类继承ILogger,它的设计思想还是一样的,只是换了一个继承接口。

SerilogLogger 里面继承Microsoft.Extensions.Logging.ILogger,实现具体的打印的。

看下SerilogLogger 的具体的部分,主要看log方法,因为这个实现打印的,这下面不用看太多,只需要看到其实里面是调用_logger的方法就行。

 internal class SerilogLogger : Microsoft.Extensions.Logging.ILogger { private static readonly MessageTemplateParser MessageTemplateParser = new MessageTemplateParser(); private static readonly LogEventProperty[] LowEventIdValues = Enumerable.Range(0, 48).Select((Func) (n => new LogEventProperty("Id", (LogEventPropertyValue) new ScalarValue((object) n)))).ToArray(); private readonly SerilogLoggerProvider _provider; private readonly Serilog.ILogger _logger; public SerilogLogger(SerilogLoggerProvider provider, Serilog.ILogger logger = null, string name = null) { SerilogLoggerProvider serilogLoggerProvider = provider; if (serilogLoggerProvider == null) throw new ArgumentNullException(nameof (provider)); this._provider = serilogLoggerProvider; this._logger = logger; Serilog.ILogger logger1 = this._logger; if (logger1 == null) logger1 = Serilog.Log.Logger.ForContext((IEnumerable) new SerilogLoggerProvider[1] { provider }); this._logger = logger1; if (name == null) return; this._logger = this._logger.ForContext("SourceContext", (object) name, false); } public bool IsEnabled(LogLevel logLevel) { return this._logger.IsEnabled(LevelConvert.ToSerilogLevel(logLevel)); } public IDisposable BeginScope(TState state) { return this._provider.BeginScope(state); } public void Log( LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) { LogEventLevel serilogLevel = LevelConvert.ToSerilogLevel(logLevel); if (!this._logger.IsEnabled(serilogLevel)) return; Serilog.ILogger logger = this._logger; string str1 = (string) null; List logEventPropertyList = new List(); if (state is IEnumerable> keyValuePairs) { foreach (KeyValuePair keyValuePair in keyValuePairs) { if (keyValuePair.Key == "{OriginalFormat}" && keyValuePair.Value is string str2) str1 = str2; else if (keyValuePair.Key.StartsWith("@")) { LogEventProperty property; if (logger.BindProperty(keyValuePair.Key.Substring(1), keyValuePair.Value, true, out property)) logEventPropertyList.Add(property); } else { LogEventProperty property; if (logger.BindProperty(keyValuePair.Key, keyValuePair.Value, false, out property)) logEventPropertyList.Add(property); } } Type type = state.GetType(); TypeInfo typeInfo = type.GetTypeInfo(); if (str1 == null && !typeInfo.IsGenericType) { str1 = "{" + type.Name + ":l}"; LogEventProperty property; if (logger.BindProperty(type.Name, SerilogL
                
                

-六神源码网