Serilog.Settings.AppSettings 3.0.0

Serilog.Settings.AppSettings

用于 Serilog 的 XML <appSettings> 读取器。

入门指南

需要从 NuGet 安装 <appSettings> 支持包

Install-Package Serilog.Settings.AppSettings

要从 <appSettings> 读取配置，请使用您的 LoggerConfiguration 的扩展方法 ReadFrom.AppSettings()

Log.Logger = new LoggerConfiguration()
  .ReadFrom.AppSettings()
  ... // Other configuration here, then
  .CreateLogger()

可以混合使用 XML 和基于代码的配置，但每个输出必须使用 XML 或代码中的一种方式配置 - 代码中添加的输出无法通过应用程序设置进行修改。

配置语法

为了配置记录器，应在程序的两个配置文件 App.config 或 Web.config 中包含 <appSettings> 元素。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="serilog:minimum-level" value="Verbose" />
    

Serilog 设置以 serilog: 前缀。

设置最低级别

使用 serilog:minimum-level 设置键设置应用程序的日志级别。

    <add key="serilog:minimum-level" value="Verbose" />

有效值是 LogEventLevel 列表中定义的值：Verbose、Debug、Information、Warning、Error、Fatal。

添加输出

使用 serilog:write-to 键添加输出。设置名称与您在代码中使用配置方法名称相匹配，因此以下两种方式是等效的

    .WriteTo.Console()

在 XML 中

    <add key="serilog:write-to:Console" />

注意：使用 serilog:* 键时，需要唯一。

必须使用 serilog:using 语法指定存储库程序集。例如，为了配置

<add key="serilog:using:Console" value="Serilog.Sinks.Console" />
<add key="serilog:write-to:Console"/>

如果输出接受参数，则通过将参数名称附加到设置来指定它们。

    .WriteTo.File(@"C:\Logs\myapp-{Date}.txt", retainedFileCountLimit: 10)

在 XML 中

    <add key="serilog:write-to:File.path" value="C:\Logs\myapp-{Date}.txt" />
    <add key="serilog:write-to:File.retainedFileCountLimit" value="10" />

设置值中指定的任何环境变量（例如 %TEMP%）将在读取时适当地展开。

使用来自附加程序集的输出扩展

要使用来自其他程序集的输出和增强器，请使用 serilog:using 键指定它们。

例如，为了使用来自 Serilog.Sinks.EventLog 程序集的配置

    <add key="serilog:using:EventLog" value="Serilog.Sinks.EventLog" />
    <add key="serilog:write-to:EventLog.source" value="Serilog Demo" />

使用属性增强

要为日志事件附加额外的属性，请使用 serilog:enrich:with-property 指令指定它们。

例如，为了将具有值 "1.2-develop" 的属性 Release 添加到所有事件中

    <add key="serilog:enrich:with-property:Release" value="1.2-develop" />

添加最低级别覆盖

从 Serilog 2.1 开始，可以添加 最低级别覆盖 来更改某些特定命名空间的最小级别。这通过设置键 serilog:minimum-level:override: 后跟 源上下文前缀 完成。

例如，以下两种方式是等效的

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
    .MinimumLevel.Override("Microsoft.AspNetCore.Mvc", LogEventLevel.Error)

以及在 XML 中

    <add key="serilog:minimum-level" value="Information" />
    <add key="serilog:minimum-level:override:Microsoft" value="Warning" />
    <add key="serilog:minimum-level:override:Microsoft.AspNetCore.Mvc" value="Error" />

过滤

可以使用 Serilog.Filters.Expressions 包来指定过滤器；有关更多信息，请参阅那里的 README。

从枚举设置值

在配置使用枚举值设置的输出时，请使用成员名称，而无需指定枚举的名称。

例如，为了将 File Sink 中 RollingInterval 的配置设置为每天创建一个新的日志文件，请使用 Day 而不是 RollingInterval.Day

    <add key="serilog:write-to:File.rollingInterval" value="Day"/>

如果您指定了枚举的名称，您将收到类似于 System.ArgumentException: 请求的值 'RollingInterval.Day' 未找到 的错误

解构

LoggerConfiguration
    .Destructure.ToMaximumDepth(maximumDestructuringDepth: 3)
    .Destructure.ToMaximumStringLength(maximumStringLength: 3)
    .Destructure.ToMaximumCollectionCount(maximumCollectionCount: 3)
    .Destructure.AsScalar(typeof(System.Version))
    .Destructure.With(new CustomPolicy());

以及在 XML 中

<add key="serilog:destructure:ToMaximumDepth.maximumDestructuringDepth" value="3" />
<add key="serilog:destructure:ToMaximumStringLength.maximumStringLength" value="3" />
<add key="serilog:destructure:ToMaximumCollectionCount.maximumCollectionCount" value="3" />
<add key="serilog:destructure:AsScalar.scalarType" value="System.Version" />
<add key="serilog:destructure:With.policy" value="My.CustomPolicy, MyAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />