Serilog.Sinks.Console 6.0.1-dev-00953

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
4,656
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
514
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
298
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
65
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
61
Serilog.Sinks.ColoredConsole
Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog
57
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
57
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
54
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
53
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
52
Serilog.Sinks.ColoredConsole
Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog
51
Serilog.Sinks.ColoredConsole
Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog
50
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
50
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
49

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