Serilog.Exceptions.Refit 8.4.0

Serilog.Exceptions 是 Serilog 的一个扩展，用于记录异常详细信息以及不在 Exception.ToString() 中输出的自定义属性。

它的作用是什么？

您的 JSON 日志现在将补充详细的异常信息和自定义异常属性。以下是一个从 EntityFramework (此异常因具有深度嵌套的自定义属性而闻名，这些属性不包括在 .ToString() 中) 记录 DbEntityValidationException 的示例。

try
{
    ...
}
catch (DbEntityValidationException exception)
{
    logger.Error(exception, "Hello World");
}

上面的代码记录了以下内容

{
  "Timestamp": "2015-12-07T12:26:24.0557671+00:00",
  "Level": "Error",
  "MessageTemplate": "Hello World",
  "RenderedMessage": "Hello World",
  "Exception": "System.Data.Entity.Validation.DbEntityValidationException: Message",
  "Properties": {
    "ExceptionDetail": {
      "EntityValidationErrors": [
        {
          "Entry": null,
          "ValidationErrors": [
            {
              "PropertyName": "PropertyName",
              "ErrorMessage": "PropertyName is Required.",
              "Type": "System.Data.Entity.Validation.DbValidationError"
            }
          ],
          "IsValid": false,
          "Type": "System.Data.Entity.Validation.DbEntityValidationResult"
        }
      ],
      "Message": "Validation failed for one or more entities. See 'EntityValidationErrors' property for more details.",
      "Data": {},
      "InnerException": null,
      "TargetSite": null,
      "StackTrace": null,
      "HelpLink": null,
      "Source": null,
      "HResult": -2146232032,
      "Type": "System.Data.Entity.Validation.DbEntityValidationException"
    },
    "Source": "418169ff-e65f-456e-8b0d-42a0973c3577"
  }
}

快速入门

使用 NuGet 包管理器将 Serilog.Exceptions NuGet 包添加到您的项目中，或在包控制台窗口中运行以下命令

dotnet add package Serilog.Exceptions

在设置您的日志记录器时，像这样添加 WithExceptionDetails() 行

using Serilog;
using Serilog.Exceptions;

ILogger logger = new LoggerConfiguration()
    .Enrich.WithExceptionDetails()
    .WriteTo.RollingFile(
        new JsonFormatter(renderMessage: true), 
        @"C:\logs\log-{Date}.txt")    
    .CreateLogger();

确保输出丰富属性的 sink 的格式化程序。默认情况下，Serilog.Sinks.Console 和许多其他格式化程序都不这样做。您可能需要将 {Properties:j} 添加到 sink 的格式化模板中。例如，控制台 sink 配置可能如下所示

.WriteTo.Console(outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception} {Properties:j}")

JSON appSettings.json 配置

此外，可以使用 Serilog.Settings.Configuration 将配置放在应用程序配置中，而不是使用流畅配置设置

{
  "Serilog": {
    "Using": [ "Serilog.Exceptions" ],
    "Enrich": [ "WithExceptionDetails" ],
    "WriteTo": [
      { "Name": "Console" }
    ]
  }
}

性能

此库具有用于处理常见异常类型中额外属性的代码，并且仅在异常不支持 Serilog.Exceptions 内部时才回退到使用反射来获取额外信息。存在反射开销，但非常小，因为所有昂贵的基于反射的操作都仅对每个异常类型执行一次。

额外的解除结构器

Serilog.Exceptions.SqlServer

将 Serilog.Exceptions.SqlServer NuGet 包添加到您的项目中，以避免使用 System.Data.SqlClient 时对 SqlException 的基于反射的解除结构器

Install-Package Serilog.Exceptions.SqlServer

在设置期间添加 SqlExceptionDestructurer

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new SqlExceptionDestructurer() }))

Serilog.Exceptions.MsSqlServer

将 Serilog.Exceptions.MsSqlServer NuGet 包添加到您的项目中，以避免使用 Microsoft.Data.SqlClient 时对 SqlException 的基于反射的解除结构器

Install-Package Serilog.Exceptions.MsSqlServer

在设置期间添加 SqlExceptionDestructurer

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new SqlExceptionDestructurer() }))

Serilog.Exceptions.EntityFrameworkCore

警告：在 Serilog.Exceptions 的版本低于 8.0.0 时，如果您使用 EntityFrameworkCore 与 Serilog.Exceptions，则必须添加此功能，否则在某些情况下，您的整个数据库都将被记录！这是因为 Entity Framework Core 中的异常具有链接到整个数据库模式的属性（见 #100，aspnet/EntityFrameworkCore#15214）。Serilog.Exceptions 的新版本通过防止解构实现 IQueryable 的属性来避免此问题，防止它们的执行。

当在项目中使用 EntityFrameworkCore 时，将 Serilog.Exceptions.EntityFrameworkCore NuGet 包添加到您的项目中

Install-Package Serilog.Exceptions.EntityFrameworkCore

在设置期间添加 DbUpdateExceptionDestructurer

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new DbUpdateExceptionDestructurer() }))

Serilog.Exceptions.Refit

将 Serilog.Exceptions.Refit NuGet 包添加到您的项目中，以提供在使用 Refit 时的 ApiException 的详细日志记录

Install-Package Serilog.Exceptions.Refit

在设置期间添加 ApiExceptionDestructurer

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new ApiExceptionDestructurer() }))

根据您的 Serilog 设置，常见的 System.Exception 属性可能已经记录。要跳过这些属性的记录，请使用以下重载的构造函数

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new ApiExceptionDestructurer(destructureCommonExceptionProperties: false) }))

默认配置将记录以下ApiException属性：

• Uri
• StatusCode

此外，还可以通过以下设置记录ApiException.Content属性

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new ApiExceptionDestructurer(destructureHttpContent: true) }))

请注意此选项，因为HTTP正文可能非常大，且/或包含敏感信息。

Serilog.Exceptions.Grpc

将Serilog.Exceptions.Grpc NuGet包添加到您的项目中，以避免在使用Grpc.Net.Client时基于反射的RpcException解构器。

Install-Package Serilog.Exceptions.Grpc

在设置过程中添加RpcExceptionDestructurer

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new RpcExceptionDestructurer() }))

自定义异常解构器

您可能想添加对自定义异常解构的支持，而不依赖于反射。为此，创建一个实现ExceptionDestructurer的自定义解构类（您可以查看此文件以了解如何为ArgumentException实现），然后简单添加如下

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithDestructurers(new[] { new MyCustomExceptionDestructurer() }))

如果您编写了一个不包括在此项目中的解构器（即使是第三方库），请贡献它。

其他配置

您可以通过在设置期间传递自定义解构选项来配置解构过程的某些其他属性

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder()
    .WithDefaultDestructurers()
    .WithRootName("Exception"))

目前支持以下选项

• RootName：将储有解构异常的属性名，默认为ExceptionDetail。
• Filter：实现IExceptionPropertyFilter的对象，在将属性放入解构异常对象之前有机会过滤这些属性。有关详细信息，请参阅“属性过滤”部分。
• DestructuringDepth：基于反射的递归解构过程的最大深度。
• ReflectionBasedDestructurer：默认启用基于反射的解构器，但在想要完全控制解构过程时可以禁用它。您将需要明确注册所有异常的解构器。

属性过滤

您可能想跳过所有或部分异常类的一些属性，而无需直接创建或修改自定义解构器。Serilog.Exceptions使用过滤器支持此功能。

最常见的用例是需要跳过StackTrace和TargetSite。Serilog已经报告了它们，因此您可能希望Serilog.Exceptions跳过它们以节省空间和加工时间。要做到这一点，只需修改配置中的一行即可。

.Enrich.WithExceptionDetails(new DestructuringOptionsBuilder().WithFilter(someFilter));

也支持其他场景的过滤

• 如果需要过滤其他一组具有指定名称的属性，请使用WithIgnoreStackTraceAndTargetSiteExceptionFilter
• 实现自定义的IExceptionPropertyFilter以获取不同的过滤逻辑
• 使用CompositeExceptionPropertyFilter来组合多个过滤器

持续集成

名称	操作系统	状态	历史
Azure Pipelines	Ubuntu
Azure Pipelines	Mac
Azure Pipelines	Windows
Azure Pipelines	总体
GitHub Actions	Ubuntu，Mac和Windows
AppVeyor	Ubuntu，Mac和Windows

贡献和感谢

请查看贡献指南以获取更多信息。

• 304NotModified - 添加Markdown语法高亮。
• joelweiss - 添加Entity Framework Core解构器。
• krajek 和 JeroenDragt - 为添加过滤器以帮助忽略不想记录的异常属性做出贡献。
• krajek - 在使用反射解构器时帮助解决循环依赖问题。
• mraming - 为记录引发异常的属性做出贡献。
• optical - 为巨大的VS 2017升级PR做出贡献。
• Jean-Baptiste Bertrand - 使Serilog.Exceptions与Mono兼容。
• krajek - 用于编写一些急需的单元测试。