重新整理 .net core 實踐篇—————日誌系統之結構化[十八]

不問前世 發表於 2021-06-11
.Net

前言

什麼是結構化呢? 結構化,就是將原本沒有規律的東西進行有規律話。

就比如我們學習資料結構,需要學習排序然後又要學習查詢,說白了這就是一套,沒有排序,談如何查詢是沒有意義的,因為查詢演算法就是根據某種規律得到最佳的效果。

同樣日誌結構話,能夠讓我們得到一些好處。如果說容易檢索,容易分析,總的來說就是讓我們的日誌更加有規律。

如果我們的日誌結構化了,那麼可以使用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<Startup>();
		}).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;
    }
}

輸出:

重新整理 .net core 實踐篇—————日誌系統之結構化[十八]

這時候發現我們的輸出都json化了。

同時在根目錄下的logs目錄下輸出日誌檔案:

重新整理 .net core 實踐篇—————日誌系統之結構化[十八]

但是我們這樣發現,日誌太多了,我們需要過濾掉一些日誌,那麼我們可以配置:

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

測試程式碼:

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

結果:
重新整理 .net core 實踐篇—————日誌系統之結構化[十八]

因為上面配置了Microsoft 為Error級別的,故而系統列印的日誌只有Error基本才會輸出。

這裡面簡單看一下Serilog 的原理,因為https://www.cnblogs.com/aoximin/p/14854519.html 已經介紹了日誌系統的基本結果,故而直接往下續:

檢視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<HostBuilderContext, IServiceCollection>) ((_, collection) =>
  {
	if (providers != null)
	  ServiceCollectionServiceExtensions.AddSingleton<ILoggerFactory>(collection, (Func<IServiceProvider, M0>) (services =>
	  {
		SerilogLoggerFactory serilogLoggerFactory = new SerilogLoggerFactory(logger, dispose, providers);
		foreach (ILoggerProvider service in (IEnumerable<ILoggerProvider>) ServiceProviderServiceExtensions.GetServices<ILoggerProvider>(services))
		  serilogLoggerFactory.AddProvider(service);
		return (ILoggerFactory) serilogLoggerFactory;
	  }));
	else
	  ServiceCollectionServiceExtensions.AddSingleton<ILoggerFactory>(collection, (Func<IServiceProvider, M0>) (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<IServiceProvider, M0>) (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;
}

/// <summary>Disposes the provider.</summary>
public void Dispose()
{
  this._provider.Dispose();
}

/// <summary>
/// Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.
/// </summary>
/// <param name="categoryName">The category name for messages produced by the logger.</param>
/// <returns>
/// The <see cref="T:Microsoft.Extensions.Logging.ILogger" />.
/// </returns>
public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
{
  return this._provider.CreateLogger(categoryName);
}

/// <summary>
/// Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.
/// </summary>
/// <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
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<ILogEventEnricher>) 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<int, LogEventProperty>((Func<int, LogEventProperty>) (n => new LogEventProperty("Id", (LogEventPropertyValue) new ScalarValue((object) n)))).ToArray<LogEventProperty>();
    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<ILogEventEnricher>) 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>(TState state)
    {
      return this._provider.BeginScope<TState>(state);
    }

    public void Log<TState>(
      LogLevel logLevel,
      EventId eventId,
      TState state,
      Exception exception,
      Func<TState, Exception, string> formatter)
    {
      LogEventLevel serilogLevel = LevelConvert.ToSerilogLevel(logLevel);
      if (!this._logger.IsEnabled(serilogLevel))
        return;
      Serilog.ILogger logger = this._logger;
      string str1 = (string) null;
      List<LogEventProperty> logEventPropertyList = new List<LogEventProperty>();
      if (state is IEnumerable<KeyValuePair<string, object>> keyValuePairs)
      {
        foreach (KeyValuePair<string, object> 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, SerilogLogger.AsLoggableValue<TState>(state, formatter), false, out property))
            logEventPropertyList.Add(property);
        }
      }
      if (str1 == null)
      {
        string propertyName = (string) null;
        if ((object) state != null)
        {
          propertyName = "State";
          str1 = "{State:l}";
        }
        else if (formatter != null)
        {
          propertyName = "Message";
          str1 = "{Message:l}";
        }
        LogEventProperty property;
        if (propertyName != null && logger.BindProperty(propertyName, SerilogLogger.AsLoggableValue<TState>(state, formatter), false, out property))
          logEventPropertyList.Add(property);
      }
      if (eventId.Id != 0 || eventId.Name != null)
        logEventPropertyList.Add(SerilogLogger.CreateEventIdProperty(eventId));
      MessageTemplate messageTemplate = SerilogLogger.MessageTemplateParser.Parse(str1 ?? "");
      LogEvent logEvent = new LogEvent(DateTimeOffset.Now, serilogLevel, exception, messageTemplate, (IEnumerable<LogEventProperty>) logEventPropertyList);
      logger.Write(logEvent);
    }
}

那麼SerilogLogger 的_logger 到底是什麼呢?我們可以看到其實這個_logger 是SerilogLoggerFactory到SerilogLoggerProvider到SerilogLogger一層一層傳進去的,最後呼叫ForContext生成,上面可以看到具體各個的例項化函式。

如果我們不傳的話,那麼會預設使用 Serilog.Log.Logger,在SerilogLogger的例項化函式中這樣寫道:

Serilog.ILogger logger1 = this._logger;
  if (logger1 == null)
	logger1 = Serilog.Log.Logger.ForContext((IEnumerable<ILogEventEnricher>) new SerilogLoggerProvider[1]
	{
	  provider
	});
  this._logger = logger1;

而在UseSerilog中logger引數的引數介紹中也寫道: The Serilog logger; if not supplied, the static will be used.

之所以重點談論這個_logger 這個資料,是為了引出Serilog.Log.Logger這個東西,是不是感覺特別眼熟?我們在Startup的ConfigureServices中寫道:

services.AddLogSeriLog(Configuration);

AddLogSeriLog 為:

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;
}

這裡我們就生成了具體列印實現類的管理類,是代理模式哈。大體就是各個不同的實現類繼承ILogEventSink,然後SafeAggregateSink也繼承自ILogEventSink,SafeAggregateSink裡面有個屬性readonly ILogEventSink[] _sinks,然後呼叫Serilog的 Logger

類呼叫write方法會呼叫SafeAggregateSink的Emit。

SafeAggregateSink類如下,主要看下Emit方法:

class SafeAggregateSink : ILogEventSink
{
	readonly ILogEventSink[] _sinks;

	public SafeAggregateSink(IEnumerable<ILogEventSink> sinks)
	{
		if (sinks == null) throw new ArgumentNullException(nameof(sinks));
		_sinks = sinks.ToArray();
	}

	public void Emit(LogEvent logEvent)
	{
		foreach (var sink in _sinks)
		{
			try
			{
                                // 呼叫不同的Log列印的實現類 如檔案、控制檯 等
				sink.Emit(logEvent);
			}
			catch (Exception ex)
			{
				SelfLog.WriteLine("Caught exception while emitting to sink {0}: {1}", sink, ex);
			}
		}
	}
}

具體就不細寫了,裡面都是一些格式匹配的,根據我們上面的分析,其實我們應該知道先看CreateLogger這個函式哈,然後去看Console這個函式。如對格式化感興趣可

以去看下哈,裡面又套了一層代理模式的娃。

上述只是個人整理,如有錯誤,望請指出,謝謝。

下一次 中介軟體。 前面其實寫個中介軟體的一些基本概念,介紹其實中介軟體就是職責鏈模式,所以下一節主要整理一下具體實踐。