Serilog.Sinks.Console 6.0.0

Serilog.Sinks.Console

A Serilog sink that writes log events to the Windows console or an ANSI terminal via standard output. It supports coloring and custom themes, including ANSI 256-color themes on macOS, Linux, and Windows 10. The default output is plain text; JSON formatting can be connected using a package such as Serilog.Formatting.Compact.

入门指南

要使用控制台接收器，首先安装NuGet 包

dotnet add package Serilog.Sinks.Console

然后使用 WriteTo.Console() 启用接收器

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .CreateLogger();
    
Log.Information("Hello, world!");

日志事件将打印到 STDOUT

[12:50:51 INF] Hello, world!

主题

默认情况下，接收器将彩色渲染输出

可以在配置接收器时指定主题

    .WriteTo.Console(theme: AnsiConsoleTheme.Code)

以下是一些内置的主题：

• ConsoleTheme.None - 无样式
• SystemConsoleTheme.Literate - 以类似 Serilog.Sinks.Literate 的样式进行设计，使用支持所有 Windows/.NET 目标的 System.Console 色彩模式；这是没有指定主题时的默认值
• SystemConsoleTheme.Grayscale - 只使用灰色、白色和黑色的主题
• AnsiConsoleTheme.Literate - “书面”主题的 ANSI 256 色版本
• AnsiConsoleTheme.Grayscale - “灰色”主题的 ANSI 256 色版本
• AnsiConsoleTheme.Code -灵感来源于 Visual Studio Code 的 ANSI 256 色主题
• AnsiConsoleTheme.Sixteen -兼容浅色和深色背景的 ANSI 16 色主题

添加新主题很简单；有关示例，请参阅 SystemConsoleThemes 和 AnsiConsoleThemes 类。

输出模板

可以使用 outputTemplate 配置参数修改发送到控制台的日志事件格式

    .WriteTo.Console(
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")

默认模板（如上例所示）使用内置属性，如 Timestamp 和 Level。来自事件的属性，包括使用 丰富器附加的属性，也可以出现在输出模板中。

JSON 输出

接收器可以写入 JSON 输出而不是纯文本。建议使用来自 Serilog.FormattingCompact 的 CompactJsonFormatter 或 RenderedCompactJsonFormatter

dotnet add package Serilog.Formatting.Compact

将格式化程序传递给 Console() 配置方法

    .WriteTo.Console(new RenderedCompactJsonFormatter())

当使用自定义格式化程序时，不可用输出主题

<appSettings> XML 配置

要使用控制台接收器与 Serilog.Settings.AppSettings 包，如果您尚未安装，请先安装该包

dotnet add package Serilog.Settings.AppSettings

调用 ReadFrom.AppSettings() 代替在代码中配置记录器

var log = new LoggerConfiguration()
    .ReadFrom.AppSettings()
    .CreateLogger();

在您的应用程序的 App.config 或 Web.config 文件中，指定 <appSettings> 节下的控制台接收器程序集

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

要使用不同的主题，并在输出中包含 SourceContext，将您的 App.config/Web.config 修改如下：

<configuration>
  <appSettings>
    <add key="serilog:using:Console" value="Serilog.Sinks.Console" />
    <add key="serilog:write-to:Console.theme" value="Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console" />
    <add key="serilog:write-to:Console.outputTemplate" value="[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} &lt;s:{SourceContext}&gt;{NewLine}{Exception}" />

JSON appsettings.json 配置

要使用控制台接收器与Microsoft.Extensions.Configuration一起使用，例如与ASP.NET Core或.NET Core一起使用，请使用Serilog.Settings.Configuration包。首先安装该包，如果尚未安装的话

dotnet add package Serilog.Settings.Configuration

而不是直接在代码中配置接收器，请调用ReadFrom.Configuration()

var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var logger = new LoggerConfiguration()
    .ReadFrom.Configuration(configuration)
    .CreateLogger();

在您的appsettings.json文件中，在Serilog节点下

{
  "Serilog": {
    "WriteTo": [{"Name": "Console"}]
  }
}

要使用不同的主题配置控制台接收器，并在输出中包含SourceContext，请将您的appsettings.json更改如下

{
  "Serilog": {
    "WriteTo": [
      {
          "Name": "Console",
          "Args": {
            "theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
            "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} <s:{SourceContext}>{NewLine}{Exception}"
          }
      }
    ]
  }
}

性能

控制台日志记录是同步的，这可能在某些部署场景中造成瓶颈。对于高量的控制台日志记录，请考虑使用Serilog.Sinks.Async将控制台写入移动到一个后台线程

// dotnet add package serilog.sinks.async

Log.Logger = new LoggerConfiguration()
    .WriteTo.Async(wt => wt.Console())
    .CreateLogger();

贡献

您是否想帮助使Serilog控制台接收器变得更好？我们保留了一个针对新手的可操作问题的列表，标签为up-for-grabs。在开始工作之前，我们建议在问题跟踪器上评论或提出一个问题，这样我们可以帮助并协调工作。有关更多详细信息，请查看我们的贡献指南。

在贡献时，请牢记我们的行为准则。

详细的构建状态

分支	AppVeyor	Travis
dev
main

版权所有 © Serilog 贡献者 - 在Apache License, Version 2.0许可下提供。