Serilog.Sinks.Console 6.0.0

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
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
61
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
48
Nuke.Common
Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit '39132f3fb1fea9f889894dfe520cf4434d6eca4e' (see contained AppVeyorSettings.json file for build settings).
47
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
45
Nuke.Common
Cross-platform build automation system Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit '4a24cd4e78d43b59deb8aa2033c696c8ceb51dd6' (see contained AppVeyorSettings.json file for build settings).
43
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
43
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
41
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
40
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
38
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
37
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
36

.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 19 02/22/2025
6.0.0 24 06/17/2024
6.0.0-dev-00946 20 06/24/2024
5.1.0-dev-00943 27 03/30/2024
5.0.2-dev-00942 33 03/30/2024
5.0.1 22 02/19/2024
5.0.1-dev-00928 22 02/16/2024
5.0.0 23 02/20/2024
5.0.0-dev-00923 23 02/10/2024
4.2.0-dev-00918 19 02/10/2024
4.1.1-dev-00917 25 02/11/2024
4.1.1-dev-00910 50 04/02/2023
4.1.1-dev-00907 58 05/29/2023
4.1.1-dev-00901 33 08/28/2023
4.1.1-dev-00896 26 12/27/2023
4.1.0 40 09/14/2023
4.1.0-dev-00893 22 08/31/2023
4.0.2-dev-00890 25 09/01/2023
4.0.1 29 03/29/2023
4.0.1-dev-00879 20 08/25/2023
4.0.1-dev-00876 24 08/31/2023
4.0.1-dev-00874 19 08/27/2023
4.0.0 76 09/10/2021
4.0.0-dev-00870 34 08/28/2023
4.0.0-dev-00839 21 08/30/2023
4.0.0-dev-00837 39 08/25/2023
4.0.0-dev-00834 26 08/25/2023
4.0.0-dev-00832 32 08/31/2023
4.0.0-dev-00831 31 08/27/2023
3.1.2-dev-00824 45 08/30/2023
3.1.2-dev-00823 22 08/31/2023
3.1.2-dev-00819 20 02/16/2024
3.1.2-dev-00811 34 05/18/2023
3.1.2-dev-00806 24 08/26/2023
3.1.2-dev-00802 41 08/27/2023
3.1.2-dev-00800 22 08/31/2023
3.1.2-dev-00798 18 08/31/2023
3.1.2-dev-00796 15 08/25/2023
3.1.2-dev-00792 23 08/30/2023
3.1.2-dev-00788 28 08/26/2023
3.1.2-dev-00786 19 08/26/2023
3.1.2-dev-00779 23 08/29/2023
3.1.2-dev-00777 20 08/29/2023
3.1.2-dev-00774 25 02/16/2024
3.1.2-dev-00771 32 05/18/2023
3.1.1 74 12/27/2019
3.1.1-dev-00764 27 02/16/2024
3.1.1-dev-00762 20 08/27/2023
3.1.1-dev-00757 29 08/24/2023
3.1.0 39 06/13/2023
3.0.2-dev-00753 22 08/26/2023
3.0.1 35 09/21/2023
3.0.1-dev-00749 22 02/16/2024
3.0.1-dev-00747 59 05/17/2023
3.0.0 54 06/01/2023
3.0.0-dev-00737 25 08/24/2023
3.0.0-dev-00735 21 02/16/2024
3.0.0-dev-00734 25 08/25/2023
3.0.0-dev-00732 20 08/26/2023
2.2.0-dev-00721 21 08/25/2023
2.2.0-dev-00719 22 08/30/2023
2.1.0 94 06/02/2021
2.1.0-dev-00715 20 08/25/2023
2.1.0-dev-00713 32 09/04/2023
2.0.0 23 02/12/2024
2.0.0-rc-709 24 02/16/2024
2.0.0-beta-707 28 08/26/2023
2.0.0-beta-706 26 08/31/2023
2.0.0-beta-700 16 08/29/2023
2.0.0-beta-513 21 08/25/2023
2.0.0-beta-511 30 08/24/2023
2.0.0-beta-509 39 08/29/2023
2.0.0-beta-507 32 08/29/2023
2.0.0-beta-505 47 07/29/2023
2.0.0-beta-502 17 08/27/2023
2.0.0-beta-499 30 08/21/2023
2.0.0-beta-495 23 08/30/2023
2.0.0-beta-494 16 08/27/2023
2.0.0-beta-493 19 08/24/2023
2.0.0-beta-487 22 08/30/2023
2.0.0-beta-486 23 08/28/2023
2.0.0-beta-479 24 08/31/2023
2.0.0-beta-478 35 05/27/2023
2.0.0-beta-465 21 08/26/2023
2.0.0-beta-456 29 08/30/2023
2.0.0-beta-450 27 08/27/2023
2.0.0-beta-449 38 06/06/2023