Serilog.Sinks.Console 6.0.0-dev-00946

Serilog.Sinks.Console Build status NuGet Version Documentation Help

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

Getting started

To use the console sink, first install the NuGet package:

dotnet add package Serilog.Sinks.Console

Then enable the sink using WriteTo.Console():

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

Log events will be printed to STDOUT:

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

Themes

The sink will colorize output by default:

Colorized Console

Themes can be specified when configuring the sink:

    .WriteTo.Console(theme: AnsiConsoleTheme.Code)

The following built-in themes are available:

  • ConsoleTheme.None - no styling
  • SystemConsoleTheme.Literate - styled to replicate Serilog.Sinks.Literate, using the System.Console coloring modes supported on all Windows/.NET targets; this is the default when no theme is specified
  • SystemConsoleTheme.Grayscale - a theme using only shades of gray, white, and black
  • AnsiConsoleTheme.Literate - an ANSI 256-color version of the "literate" theme
  • AnsiConsoleTheme.Grayscale - an ANSI 256-color version of the "grayscale" theme
  • AnsiConsoleTheme.Code - an ANSI 256-color Visual Studio Code-inspired theme
  • AnsiConsoleTheme.Sixteen - an ANSI 16-color theme that works well with both light and dark backgrounds

Adding a new theme is straightforward; examples can be found in the SystemConsoleThemes and AnsiConsoleThemes classes.

Output templates

The format of events to the console can be modified using the outputTemplate configuration parameter:

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

The default template, shown in the example above, uses built-in properties like Timestamp and Level. Properties from events, including those attached using enrichers, can also appear in the output template.

JSON output

The sink can write JSON output instead of plain text. CompactJsonFormatter or RenderedCompactJsonFormatter from Serilog.Formatting.Compact is recommended:

dotnet add package Serilog.Formatting.Compact

Pass a formatter to the Console() configuration method:

    .WriteTo.Console(new RenderedCompactJsonFormatter())

Output theming is not available when custom formatters are used.

XML <appSettings> configuration

To use the console sink with the Serilog.Settings.AppSettings package, first install that package if you haven't already done so:

dotnet add package Serilog.Settings.AppSettings

Instead of configuring the logger in code, call ReadFrom.AppSettings():

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

In your application's App.config or Web.config file, specify the console sink assembly under the <appSettings> node:

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

To configure the console sink with a different theme and include the SourceContext in the output, change your App.config/Web.config to:

<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 configuration

To use the console sink with Microsoft.Extensions.Configuration, for example with ASP.NET Core or .NET Core, use the Serilog.Settings.Configuration package. First install that package if you have not already done so:

dotnet add package Serilog.Settings.Configuration

Instead of configuring the sink directly in code, call ReadFrom.Configuration():

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

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

In your appsettings.json file, under the Serilog node, :

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

To configure the console sink with a different theme and include the SourceContext in the output, change your appsettings.json to:

{
  "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}"
          }
      }
    ]
  }
}

Performance

Console logging is synchronous and this can cause bottlenecks in some deployment scenarios. For high-volume console logging, consider using Serilog.Sinks.Async to move console writes to a background thread:

// dotnet add package serilog.sinks.async

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

Contributing

Would you like to help make the Serilog console sink even better? We keep a list of issues that are approachable for newcomers under the up-for-grabs label. Before starting work on a pull request, we suggest commenting on, or raising, an issue on the issue tracker so that we can help and coordinate efforts. For more details check out our contributing guide.

When contributing please keep in mind our Code of Conduct.

Detailed build status

Branch AppVeyor Travis
dev Build status Build Status
main Build status Build Status

Copyright © Serilog Contributors - Provided under the Apache License, Version 2.0.

Showing the top 20 packages that depend on Serilog.Sinks.Console.

Packages Downloads
Quantum.Framework.ThinWebApp
Package Description
103
Quantum.Framework.WebApp
Package Description
79
Quantum.Framework.WebApp
Package Description
80
Quantum.Framework.WebApp
Package Description
90
Quantum.Framework.WebApp
Package Description
111
Quantum.Framework.WebApp
Package Description
131
Quantum.Framework.WebApp
Package Description
159
Quantum.Framework.WebApp
Package Description
173
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
78
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
79
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
81
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
83
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
85
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
88
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
105
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
150
Quantum.Framework.WebApp
提供TMS/WMS/OMS/AMS等共享的组件
193
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
197

.NET Framework 4.6.2

.NET Framework 4.7.1

.NET 6.0

.NET 8.0

.NET Standard 2.0

Version Downloads Last updated
6.0.1-dev-00953 25 03/10/2025
6.0.0 28 11/01/2024
6.0.0-dev-00946 15 11/27/2024
5.1.0-dev-00943 34 05/28/2024
5.0.2-dev-00942 28 05/28/2024
5.0.1 344 01/26/2024
5.0.1-dev-00928 22 05/28/2024
5.0.0 69 05/28/2024
5.0.0-dev-00923 22 05/28/2024
4.2.0-dev-00918 16 05/28/2024
4.1.1-dev-00917 21 05/28/2024
4.1.1-dev-00910 23 05/28/2024
4.1.1-dev-00907 23 05/28/2024
4.1.1-dev-00901 25 05/28/2024
4.1.1-dev-00896 26 05/28/2024
4.1.0 107 10/11/2022
4.1.0-dev-00893 27 05/28/2024
4.0.2-dev-00890 32 05/09/2022
4.0.1 14,303 05/19/2022
4.0.1-dev-00879 22 05/28/2024
4.0.1-dev-00876 20 05/28/2024
4.0.1-dev-00874 20 05/28/2024
4.0.0 251 04/26/2022
4.0.0-dev-00870 30 05/28/2024
4.0.0-dev-00839 20 05/28/2024
4.0.0-dev-00837 28 05/28/2024
4.0.0-dev-00834 23 05/28/2024
4.0.0-dev-00832 24 05/28/2024
4.0.0-dev-00831 23 05/28/2024
3.1.2-dev-00824 25 05/28/2024
3.1.2-dev-00823 27 05/28/2024
3.1.2-dev-00819 20 05/28/2024
3.1.2-dev-00811 22 05/28/2024
3.1.2-dev-00806 20 05/28/2024
3.1.2-dev-00802 32 05/28/2024
3.1.2-dev-00800 24 05/28/2024
3.1.2-dev-00798 23 05/28/2024
3.1.2-dev-00796 32 05/28/2024
3.1.2-dev-00792 25 05/28/2024
3.1.2-dev-00788 27 05/28/2024
3.1.2-dev-00786 22 05/28/2024
3.1.2-dev-00779 22 05/28/2024
3.1.2-dev-00777 20 05/28/2024
3.1.2-dev-00774 21 05/28/2024
3.1.2-dev-00771 24 05/28/2024
3.1.1 46 05/06/2022
3.1.1-dev-00764 23 05/28/2024
3.1.1-dev-00762 24 05/28/2024
3.1.1-dev-00757 28 05/28/2024
3.1.0 22 05/28/2024
3.0.2-dev-00753 24 05/28/2024
3.0.1 24 05/28/2024
3.0.1-dev-00749 25 05/28/2024
3.0.1-dev-00747 21 05/28/2024
3.0.0 18 05/28/2024
3.0.0-dev-00737 21 05/28/2024
3.0.0-dev-00735 21 05/28/2024
3.0.0-dev-00734 22 05/28/2024
3.0.0-dev-00732 22 05/28/2024
2.2.0-dev-00721 24 05/28/2024
2.2.0-dev-00719 25 05/28/2024
2.1.0 22 05/28/2024
2.1.0-dev-00715 23 05/08/2022
2.1.0-dev-00713 25 05/28/2024
2.0.0 30 05/28/2024
2.0.0-rc-709 26 05/28/2024
2.0.0-beta-707 23 05/28/2024
2.0.0-beta-706 26 05/28/2024
2.0.0-beta-700 23 05/28/2024
2.0.0-beta-513 21 05/28/2024
2.0.0-beta-511 24 05/28/2024
2.0.0-beta-509 26 05/28/2024
2.0.0-beta-507 21 05/28/2024
2.0.0-beta-505 26 05/25/2024
2.0.0-beta-502 23 05/28/2024
2.0.0-beta-499 23 05/28/2024
2.0.0-beta-495 23 05/28/2024
2.0.0-beta-494 25 05/28/2024
2.0.0-beta-493 28 05/28/2024
2.0.0-beta-487 27 05/28/2024
2.0.0-beta-486 25 05/28/2024
2.0.0-beta-479 23 05/28/2024
2.0.0-beta-478 23 05/28/2024
2.0.0-beta-465 33 05/28/2024
2.0.0-beta-456 26 05/28/2024
2.0.0-beta-450 24 05/28/2024
2.0.0-beta-449 26 05/28/2024