asp.net core 自定義基於 HttpContext 的 Serilog Enricher
阿新 • • 發佈:2019-12-27
asp.net core 自定義基於 HttpContext 的 Serilog Enricher
Intro
通過 HttpContext 我們可以拿到很多有用的資訊,比如 Path/QueryString/RequestHeader 等請求資訊, StatusCode/ResponseHeader 等響應資訊,藉助 HttpContext 我們可以在日誌中記錄很多有用的資訊,於是需要自定義一個基於 HttpContext 的 Enricher
實現程式碼
public class HttpContextEnricher : ILogEventEnricher { private readonly IServiceProvider _serviceProvider; private readonly Action<LogEvent, ILogEventPropertyFactory, HttpContext> _enrichAction; public HttpContextEnricher(IServiceProvider serviceProvider) : this(serviceProvider, null) { } public HttpContextEnricher(IServiceProvider serviceProvider, Action<LogEvent, ILogEventPropertyFactory, HttpContext> enrichAction) { _serviceProvider = serviceProvider; if (enrichAction == null) { _enrichAction = (logEvent, propertyFactory, httpContext) => { logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestIP", httpContext.GetUserIP())); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestPath", httpContext.Request.Path)); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestMethod", httpContext.Request.Method)); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("Referer", httpContext.Request.Headers["Referer"].ToString())); }; } else { _enrichAction = enrichAction; } } public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory) { var httpContext = _serviceProvider.GetService<IHttpContextAccessor>()?.HttpContext; if (null != httpContext) { _enrichAction.Invoke(logEvent, propertyFactory, httpContext); } } } public static class EnricherExtensions { public static LoggerConfiguration WithHttpContextInfo(this LoggerEnrichmentConfiguration enrich, IServiceProvider serviceProvider) { if (enrich == null) throw new ArgumentNullException(nameof(enrich)); return enrich.With(new HttpContextEnricher(serviceProvider)); } public static LoggerConfiguration WithHttpContextInfo(this LoggerEnrichmentConfiguration enrich, IServiceProvider serviceProvider, Action<LogEvent, ILogEventPropertyFactory, HttpContext> enrichAction) { if (enrich == null) throw new ArgumentNullException(nameof(enrich)); return enrich.With(new HttpContextEnricher(serviceProvider, enrichAction)); } }
使用方式
上面的 Enricher 允許我們定義了一個委託來自定義加從 HttpContext 中新增一些我們想要記錄的資訊了
logFactory.AddSerilog(loggingConfig => { loggingConfig .Enrich.FromLogContext() .Enrich.WithHttpContextInfo(app.ApplicationServices, (logEvent, propertyFactory, httpContext) => { logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestIP", httpContext.GetUserIP())); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestPath", httpContext.Request.Path)); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("RequestMethod", httpContext.Request.Method)); logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("Referer", httpContext.Request.Headers["Referer"].ToString())); if (httpContext.Response.HasStarted) { logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("ResponseStatus", httpContext.Response.StatusCode)); } }) ; var esConnString = Configuration.GetConnectionString("ElasticSearch"); if (esConnString.IsNotNullOrWhiteSpace()) { loggingConfig.WriteTo.Elasticsearch(esConnString, $"logstash-{ApplicationHelper.ApplicationName.ToLower()}"); } })
使用效果
More
上面的擴充套件可以自行修改,自己用的順手就好~~
Reference
- https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation/Startup.cs
- https://github.com/WeihanLi/ActivityReservation/blob/dev/ActivityReservation/SerilogEnrichers/HttpContextEnricher.cs