.net core日志系統(tǒng)相關(guān)總結(jié)
前言
本節(jié)開(kāi)始整理日志相關(guān)的東西。先整理一下日志的基本原理。
正文
首先介紹一下包:
1.Microsoft.Extengsion.Logging.Abstrations
這個(gè)是接口包。
2.Microsoft.Extengsion.Logging
這個(gè)是實(shí)現(xiàn)包
3.Microsoft.Extengsion.Logging.Console
這個(gè)是擴(kuò)展包
代碼如下:
static void Main(string[] args) { IConfigurationBuilder configurationBuilder = new ConfigurationBuilder(); configurationBuilder.AddJsonFile("appsettings.json",optional:false,reloadOnChange:true); var config = configurationBuilder.Build(); IServiceCollection serviceCollection = new ServiceCollection(); serviceCollection.AddSingleton<IConfiguration>(p=>config); serviceCollection.AddLogging(builder => { builder.AddConfiguration(config.GetSection("Logging")); builder.AddConsole(); }); IServiceProvider service = serviceCollection.BuildServiceProvider(); ILoggerFactory loggerFactory = service.GetService<ILoggerFactory>(); var loggerObj = loggerFactory.CreateLogger("Default"); loggerObj.LogInformation(2021, "Default,now that is 2021"); var loggerObj2 = loggerFactory.CreateLogger("loggerObj"); loggerObj2.LogDebug(2021, "loggerObj,now that is 2021"); Console.ReadKey(); }
配置文件:
{ "Logging": { "LogLevel": { "Default": "Debug", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" }, "Console": { "LogLevel": { "Default": "Information", "Program": "Trace", "loggerObj": "Debug" } } } }
結(jié)果:
首先是配置級(jí)別的問(wèn)題,查看loglevel 文件:
public enum LogLevel { /// <summary>Logs that contain the most detailed messages. These messages may contain sensitive application data. /// These messages are disabled by default and should never be enabled in a production environment.</summary> Trace, /// <summary>Logs that are used for interactive investigation during development. These logs should primarily contain /// information useful for debugging and have no long-term value.</summary> Debug, /// <summary>Logs that track the general flow of the application. These logs should have long-term value.</summary> Information, /// <summary>Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the /// application execution to stop.</summary> Warning, /// <summary>Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a /// failure in the current activity, not an application-wide failure.</summary> Error, /// <summary>Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires /// immediate attention.</summary> Critical, /// <summary>Not used for writing log messages. Specifies that a logging category should not write any messages.</summary> None, }
從上之下,依次提高log級(jí)別。
比如說(shuō)設(shè)置了log 級(jí)別是Error,那么Debug、Information、Warning 都不會(huì)被答應(yīng)出來(lái)。
那么就來(lái)分析一下代碼吧。
AddLogging:
public static IServiceCollection AddLogging(this IServiceCollection services, Action<ILoggingBuilder> configure) { if (services == null) { throw new ArgumentNullException(nameof(services)); } services.AddOptions(); services.TryAdd(ServiceDescriptor.Singleton<ILoggerFactory, LoggerFactory>()); services.TryAdd(ServiceDescriptor.Singleton(typeof(ILogger<>), typeof(Logger<>))); services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<LoggerFilterOptions>>( new DefaultLoggerLevelConfigureOptions(LogLevel.Information))); configure(new LoggingBuilder(services)); return services; }
這里面給注冊(cè)了ILoggerFactory和ILogger。然后設(shè)置了一個(gè)打印log的級(jí)別配置,LogLevel.Information,這個(gè)就是如果我們沒(méi)有配置文件默認(rèn)就是Information這種級(jí)別了。
configure(new LoggingBuilder(services)) 給我們的委托提供了一個(gè)LoggingBuilder的實(shí)例化對(duì)象。這個(gè)對(duì)象就是用來(lái)專(zhuān)門(mén)做擴(kuò)展的,是解耦的一種方式。
internal class LoggingBuilder : ILoggingBuilder { public LoggingBuilder(IServiceCollection services) { Services = services; } public IServiceCollection Services { get; } }
這個(gè)LoggingBuilder 類(lèi)基本什么功能都沒(méi)有,但是因?yàn)橛辛诉@樣一個(gè)類(lèi),就可以作為擴(kuò)展的標(biāo)志了。
比如說(shuō)上文的:
builder.AddConfiguration(config.GetSection("Logging")); builder.AddConsole();
看下AddConfiguration:
public static ILoggingBuilder AddConfiguration(this ILoggingBuilder builder, IConfiguration configuration) { builder.AddConfiguration(); builder.Services.AddSingleton<IConfigureOptions<LoggerFilterOptions>>(new LoggerFilterConfigureOptions(configuration)); builder.Services.AddSingleton<IOptionsChangeTokenSource<LoggerFilterOptions>>(new ConfigurationChangeTokenSource<LoggerFilterOptions>(configuration)); builder.Services.AddSingleton(new LoggingConfiguration(configuration)); return builder; }
這里面給我們注入了配置文件的配置:builder.Services.AddSingleton<IConfigureOptions>(new LoggerFilterConfigureOptions(configuration))
同時(shí)給我們注冊(cè)監(jiān)聽(tīng)令牌:builder.Services.AddSingleton<IOptionsChangeTokenSource>(new ConfigurationChangeTokenSource(configuration));
這里給我們注冊(cè)配置保存在LoggingConfiguration中:builder.Services.AddSingleton(new LoggingConfiguration(configuration));
因?yàn)長(zhǎng)oggingConfiguration 保存了,故而我們隨時(shí)可以獲取到LoggingConfiguration 的配置。
看下AddConsole:
/// <param name="builder">The <see cref="ILoggingBuilder"/> to use.</param> public static ILoggingBuilder AddConsole(this ILoggingBuilder builder) { builder.AddConfiguration(); builder.AddConsoleFormatter<JsonConsoleFormatter, JsonConsoleFormatterOptions>(); builder.AddConsoleFormatter<SystemdConsoleFormatter, ConsoleFormatterOptions>(); builder.AddConsoleFormatter<SimpleConsoleFormatter, SimpleConsoleFormatterOptions>(); builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, ConsoleLoggerProvider>()); LoggerProviderOptions.RegisterProviderOptions<ConsoleLoggerOptions, ConsoleLoggerProvider>(builder.Services); return builder; }
builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, ConsoleLoggerProvider>()) 里面給我們ILoggerProvider 增加了一個(gè)ConsoleLoggerProvider,故而我們多了一個(gè)打印的功能。
LoggerProviderOptions.RegisterProviderOptions<ConsoleLoggerOptions, ConsoleLoggerProvider>(builder.Services) 給我們加上了ConsoleLoggerOptions 綁定為ConsoleLoggerProvider的配置。
RegisterProviderOptions 如下:
public static void RegisterProviderOptions<TOptions, TProvider>(IServiceCollection services) where TOptions : class { services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<TOptions>, LoggerProviderConfigureOptions<TOptions, TProvider>>()); services.TryAddEnumerable(ServiceDescriptor.Singleton<IOptionsChangeTokenSource<TOptions>, LoggerProviderOptionsChangeTokenSource<TOptions, TProvider>>()); }
接下來(lái)就是調(diào)用服務(wù):
var loggerObj = loggerFactory.CreateLogger("Default"); loggerObj.LogInformation(2021, "Default,now that is 2021");
看下LoggerFactory的CreateLogger:
public ILogger CreateLogger(string categoryName) { if (CheckDisposed()) { throw new ObjectDisposedException(nameof(LoggerFactory)); } lock (_sync) { if (!_loggers.TryGetValue(categoryName, out Logger logger)) { logger = new Logger { Loggers = CreateLoggers(categoryName), }; (logger.MessageLoggers, logger.ScopeLoggers) = ApplyFilters(logger.Loggers); _loggers[categoryName] = logger; } return logger; } }
里面做了緩存,如果categoryName有緩存的話直接使用緩存,如果沒(méi)有那么調(diào)用CreateLoggers創(chuàng)建。
查看CreateLoggers:
private LoggerInformation[] CreateLoggers(string categoryName) { var loggers = new LoggerInformation[_providerRegistrations.Count]; for (int i = 0; i < _providerRegistrations.Count; i++) { loggers[i] = new LoggerInformation(_providerRegistrations[i].Provider, categoryName); } return loggers; }
這里面就用我們前面注冊(cè)過(guò)的全部logger的provider,封裝進(jìn)LoggerInformation。
查看LoggerInformation:
internal readonly struct LoggerInformation { public LoggerInformation(ILoggerProvider provider, string category) : this() { ProviderType = provider.GetType(); Logger = provider.CreateLogger(category); Category = category; ExternalScope = provider is ISupportExternalScope; } public ILogger Logger { get; } public string Category { get; } public Type ProviderType { get; } public bool ExternalScope { get; } }
里面調(diào)用了我們,每個(gè)provider的CreateLogger。
那么這個(gè)時(shí)候我們就找一個(gè)provider 看下CreateLogger到底做了什么,這里就找一下ConsoleLoggerProvider,因?yàn)槲覀兲砑恿诉@個(gè)。
[ProviderAlias("Console")] public class ConsoleLoggerProvider : ILoggerProvider, ISupportExternalScope { private readonly IOptionsMonitor<ConsoleLoggerOptions> _options; public ILogger CreateLogger(string name) { if (_options.CurrentValue.FormatterName == null || !_formatters.TryGetValue(_options.CurrentValue.FormatterName, out ConsoleFormatter logFormatter)) { #pragma warning disable CS0618 logFormatter = _options.CurrentValue.Format switch { ConsoleLoggerFormat.Systemd => _formatters[ConsoleFormatterNames.Systemd], _ => _formatters[ConsoleFormatterNames.Simple], }; if (_options.CurrentValue.FormatterName == null) { UpdateFormatterOptions(logFormatter, _options.CurrentValue); } #pragma warning disable CS0618 } return _loggers.GetOrAdd(name, loggerName => new ConsoleLogger(name, _messageQueue) { Options = _options.CurrentValue, ScopeProvider = _scopeProvider, Formatter = logFormatter, }); } }
看到這個(gè)IOptionsMonitor,就知道console 配置是支持熱更新的,里面創(chuàng)建了ConsoleLogger,這個(gè)ConsoleLogger就是用來(lái)打log正在的調(diào)用類(lèi)。
值得注意的是_messageQueue這個(gè),看了打印log還是有一個(gè)隊(duì)列的,按照先進(jìn)先出原則。
那么最后來(lái)看一下loggerObj.LogInformation(2021, "Default,now that is 2021");:
第一層 public static void LogInformation(this ILogger logger, EventId eventId, string message, params object[] args) { logger.Log(LogLevel.Information, eventId, message, args); } 第二層 public static void Log(this ILogger logger, LogLevel logLevel, EventId eventId, string message, params object[] args) { logger.Log(logLevel, eventId, null, message, args); } 第三層 public static void Log(this ILogger logger, LogLevel logLevel, EventId eventId, Exception exception, string message, params object[] args) { if (logger == null) { throw new ArgumentNullException(nameof(logger)); } logger.Log(logLevel, eventId, new FormattedLogValues(message, args), exception, _messageFormatter); }
那么這個(gè)logger.Log 是調(diào)用具體某個(gè)logger,像consoleLogger 嗎? 不是,我們看LoggerFactory的CreateLogger時(shí)候封裝了:
logger = new Logger { Loggers = CreateLoggers(categoryName), };
那么看下Logger的Log到底干了什么。
internal class Logger : ILogger { public LoggerInformation[] Loggers { get; set; } public MessageLogger[] MessageLoggers { get; set; } public ScopeLogger[] ScopeLoggers { get; set; } public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter) { MessageLogger[] loggers = MessageLoggers; if (loggers == null) { return; } List<Exception> exceptions = null; for (int i = 0; i < loggers.Length; i++) { ref readonly MessageLogger loggerInfo = ref loggers[i]; if (!loggerInfo.IsEnabled(logLevel)) { continue; } LoggerLog(logLevel, eventId, loggerInfo.Logger, exception, formatter, ref exceptions, state); } if (exceptions != null && exceptions.Count > 0) { ThrowLoggingError(exceptions); } static void LoggerLog(LogLevel logLevel, EventId eventId, ILogger logger, Exception exception, Func<TState, Exception, string> formatter, ref List<Exception> exceptions, in TState state) { try { logger.Log(logLevel, eventId, state, exception, formatter); } catch (Exception ex) { if (exceptions == null) { exceptions = new List<Exception>(); } exceptions.Add(ex); } } } }
里面循環(huán)判斷是否當(dāng)前級(jí)別能夠輸出:!loggerInfo.IsEnabled(logLevel)
然后調(diào)用對(duì)應(yīng)的具體ILog實(shí)現(xiàn)的Log,這里貼一下ConsoleLogger 的實(shí)現(xiàn):
[ThreadStatic] private static StringWriter t_stringWriter; public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter) { if (!IsEnabled(logLevel)) { return; } if (formatter == null) { throw new ArgumentNullException(nameof(formatter)); } t_stringWriter ??= new StringWriter(); LogEntry<TState> logEntry = new LogEntry<TState>(logLevel, _name, eventId, state, exception, formatter); Formatter.Write(in logEntry, ScopeProvider, t_stringWriter); var sb = t_stringWriter.GetStringBuilder(); if (sb.Length == 0) { return; } string computedAnsiString = sb.ToString(); sb.Clear(); if (sb.Capacity > 1024) { sb.Capacity = 1024; } _queueProcessor.EnqueueMessage(new LogMessageEntry(computedAnsiString, logAsError: logLevel >= Options.LogToStandardErrorThreshold)); }
把這個(gè)隊(duì)列的也貼一下,比較經(jīng)典吧。
internal class ConsoleLoggerProcessor : IDisposable { private const int _maxQueuedMessages = 1024; private readonly BlockingCollection<LogMessageEntry> _messageQueue = new BlockingCollection<LogMessageEntry>(_maxQueuedMessages); private readonly Thread _outputThread; public IConsole Console; public IConsole ErrorConsole; public ConsoleLoggerProcessor() { // Start Console message queue processor _outputThread = new Thread(ProcessLogQueue) { IsBackground = true, Name = "Console logger queue processing thread" }; _outputThread.Start(); } public virtual void EnqueueMessage(LogMessageEntry message) { if (!_messageQueue.IsAddingCompleted) { try { _messageQueue.Add(message); return; } catch (InvalidOperationException) { } } // Adding is completed so just log the message try { WriteMessage(message); } catch (Exception) { } } // for testing internal virtual void WriteMessage(LogMessageEntry entry) { IConsole console = entry.LogAsError ? ErrorConsole : Console; console.Write(entry.Message); } private void ProcessLogQueue() { try { foreach (LogMessageEntry message in _messageQueue.GetConsumingEnumerable()) { WriteMessage(message); } } catch { try { _messageQueue.CompleteAdding(); } catch { } } } public void Dispose() { _messageQueue.CompleteAdding(); try { _outputThread.Join(1500); // with timeout in-case Console is locked by user input } catch (ThreadStateException) { } } }
以上就是.net core日志系統(tǒng)相關(guān)總結(jié)的詳細(xì)內(nèi)容,更多關(guān)于.net core日志的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- .net core日志結(jié)構(gòu)化
- .net core 使用阿里云分布式日志的配置方法
- ASP.NET Core擴(kuò)展庫(kù)之Http日志的使用詳解
- ASP.NET Core擴(kuò)展庫(kù)之日志功能的使用詳解
- .NET Core3.0 日志 logging的實(shí)現(xiàn)
- .NET Core下使用Log4Net記錄日志的方法步驟
- Asp.Net Core用NLog記錄日志操作方法
- .NET Core開(kāi)發(fā)日志之OData(Open Data Protocol)
- .NET Core日志配置的方法
- 詳解.Net Core中的日志組件(Logging)
- .Net Core項(xiàng)目如何添加日志功能詳解
- 詳解.Net core2.0日志組件Log4net、Nlog簡(jiǎn)單性能測(cè)試
相關(guān)文章
基于Dapper實(shí)現(xiàn)分頁(yè)效果 支持篩選、排序、結(jié)果集總數(shù)等
這篇文章主要為大家詳細(xì)介紹了基于Dapper實(shí)現(xiàn)分頁(yè)效果,支持篩選,排序,結(jié)果集總數(shù),多表查詢(xún),非存儲(chǔ)過(guò)程,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-07-07.NET?Core支持Cookie和JWT混合認(rèn)證、授權(quán)的方法
這篇文章主要介紹了.NET?Core如何支持Cookie和JWT混合認(rèn)證、授權(quán),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-01-01大型門(mén)戶(hù)網(wǎng)站實(shí)現(xiàn)的十四大技術(shù)小結(jié)
參考下大型門(mén)戶(hù)網(wǎng)站的技術(shù),大家可以盡量的備份好服務(wù)器。2010-10-10Entity Framework使用Code First模式管理視圖
本文詳細(xì)講解了Entity Framework使用Code First模式管理視圖的方法,文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-03-03對(duì)ASP.Net的WebAPI項(xiàng)目進(jìn)行測(cè)試
這篇文章介紹了對(duì)WebAPI項(xiàng)目進(jìn)行測(cè)試的方法,對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-04-04在一個(gè)網(wǎng)站下再以虛擬目錄的方式掛多個(gè)網(wǎng)站的方法
在一個(gè)網(wǎng)站下再以虛擬目錄的方式掛N個(gè)網(wǎng)站的方法2010-04-04.NET微服務(wù)架構(gòu)CI/CD自動(dòng)打包鏡像
這篇文章介紹了.NET使用微服務(wù)架構(gòu)CI/CD自動(dòng)打包鏡像的方法,對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-01-01ASP.NET?MVC使用JSAjaxFileUploader插件實(shí)現(xiàn)單文件上傳
這篇文章介紹了ASP.NET?MVC使用JSAjaxFileUploader插件實(shí)現(xiàn)單文件上傳的方法,文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-09-09ASP.NET:把a(bǔ)shx寫(xiě)到類(lèi)庫(kù)里并在頁(yè)面上調(diào)用的具體方法
最近在調(diào)整博客的架構(gòu),進(jìn)一步把表現(xiàn)和業(yè)務(wù)分離,所以要把之前用ashx搞的那些Http Handler放到類(lèi)庫(kù)中,下面是具體的步驟及代碼2013-06-06