Serilog.Exceptions.MsSqlServer 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();

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

.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时提供详细的日志记录。

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 - 编写一些非常需要的单元测试。