第4部分-从Serilog请求记录中排除运行状况检查端点
作者：依乐祝
译文地址：https://www.cnblogs.com/yilezhu/p/12243984.html
原文地址：https://andrewlock.net/using-serilog-aspnetcore-in-asp-net-core-3-logging-mvc-propertis-with-serilog/
在我上篇文章中，我描述了如何配置Serilog的RequestLogging中间件以向Serilog的请求日志摘要中添加其他属性（例如请求主机名或选定的端点名称）。这些属性都在HttpContext中可用，因此可以由中间件本身直接添加。
其他属性，例如MVC特定的功能，像操作方法ID，RazorPages处理程序名称或ModelValidationState，仅在MVC上下文中可用，因此Serilog的中间件不能直接访问。
在本文中，我将展示如何创建action/page过滤器来为您记录这些属性，以便中间件可以在后续创建日志时访问。
Serilog的创建者Nicholas Blumhardt之前已经解决了这个话题。解决方案非常相似，尽管他在他的示例中创建了一个特性，您可以使用该特性来装饰actions/controllers。我在本文中跳过了这种方法，并要求将其全局应用，我希望这将是常见的解决方案。
记录来自MVC的其他信息就目前而言，ASP.NET Core中的一个特征是许多行为被MVC“基础结构”锁定在了MVC框架内部来实现。端点路由是采用MVC功能并将其下移到核心框架中的首要工作之一。ASP.NET Core团队一直在努力将更多MVC特定功能（例如模型绑定或操作结果）从MVC中移除，然后“下推”到核心框架中。有关此内容的更多信息，请参见Ryan Nowak在NDC上对Houdini项目的讨论。
但是，就目前情况而言，MVC内仍然存在一些不容易从应用程序其他部分访问的特性。当我们考虑到我们的Serilog的请求记录中间件的时候，这意味着有些属性我们也是不容易记录的。例如：
HandlerName（OnGet）
ActionId（1fbc88fa-42db-424f-b32b-c2d0994463f1）
ActionName （MyController.SomeApiMethod (MyTestApp)）
RouteData（{action = "SomeApiMethod", controller = "My", page = ""}）
ValidationState（True/ False）
在上一篇文章中我展示了如何使用RequestLogging中间件的扩展方法通过使用IDiagnosticContext将附加属性写入Serilog的请求日志中。这也仅适用于在HttpContext可用的值。在这篇文章中，我将展示如何在过滤器中使用IDiagnosticContext，以及将MVC特定值添加到日志中。我还将展示如何在中添加RazorPages特定的值（如HandlerName）。
使用自定义过滤器记录MVC属性过滤器相当于为每个请求运行的类似于MVC的微型中间件管道。.NET Core MVC中有多种类型的过滤器，每种类型的过滤器在MVC过滤器管道中的有着不同的用途（有关更多详细信息，请参见此文章）。在本文中，我们将使用最常见的过滤器之一，即Action过滤器。
Action过滤器在执行MVC操作方法之前和之后运行。他们可以访问许多MVC属性的值，例如正在执行的Action及其将被调用的参数。
下面的Action过滤器直接实现IActionFilter。该OnActionExecuting方法在调用action方法之前被调用，并将额外的MVC特定属性添加到通过构造函数传入的IDiagnosticContext中。
public class SerilogLoggingActionFilter : IActionFilter { private readonly IDiagnosticContext _diagnosticContext; public SerilogLoggingActionFilter(IDiagnosticContext diagnosticContext) { _diagnosticContext = diagnosticContext ?? throw new ArgumentNullException(nameof(diagnosticContext)); } public void OnActionExecuting(ActionExecutingContext context) { _diagnosticContext.Set("RouteData", context.ActionDescriptor.RouteValues); _diagnosticContext.Set("ActionName", context.ActionDescriptor.DisplayName); _diagnosticContext.Set("ActionId", context.ActionDescriptor.Id); _diagnosticContext.Set("ValidationState", context.ModelState.IsValid); } // Required by the interface public void OnActionExecuted(ActionExecutedContext context) { } }在将MVC服务添加到应用程序中时，可以在以下位置全局注册过滤器Startup.ConfigureServices()：
public void ConfigureServices(IServiceCollection services) { services.AddControllers(opts => { opts.Filters.Add<SerilogLoggingPageFilter>(); }); // ... other service registration }无论你使用AddControllers，AddControllersWithViews，AddMvc，或AddMvcCore的方式你都可以采用同样的方式来添加全局过滤器。
有了这个配置之后，如果你调用一个MVC控制器，你在Serilog的请求日志消息中会看到额外的数据（ActionName，ActionId，和RouteData，ValidationState）记录：
您可以在此处将所需的任何其他数据添加到日志中。只需注意记录参数值-切记不要记录敏感或个人身份信息！