Serilog.Exceptions 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提供帮助。
• Jérémie Bertrand - 让Serilog.Exceptions与Mono兼容。
• krajek - 编写一些急需的单位测试。