Serilog.Sinks.Console 5.0.2-dev-00942

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
Nuke.Build
The AKEless Build System for C#/.NET Signed by signpath.io from repository 'https://github.com/nuke-build/nuke' commit 'cda28e5941e47b2b2a3d9bea20f78d11af1d92e0' (see contained AppVeyorSettings.json file for build settings).
40
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
37
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
38
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
39
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
40
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
43
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
96
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
117
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
213
Serilog.AspNetCore.Plus
Serilog support for ASP.NET Core logging with some plus features
37
Serilog.AspNetCore.Plus
Serilog support for ASP.NET Core logging with some plus features
38
Serilog.AspNetCore.Plus
Serilog support for ASP.NET Core logging with some plus features
84
Serilog.Sinks.ColoredConsole
Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog
41
Serilog.Sinks.ColoredConsole
Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog
100

.NET Framework 4.6.2

.NET Framework 4.7.1

.NET 5.0

.NET 6.0

.NET 7.0

.NET Standard 2.0

.NET Standard 2.1

Version Downloads Last updated
6.0.0 43 07/18/2024
6.0.0-dev-00946 24 07/23/2024
5.1.0-dev-00943 31 07/23/2024
5.0.2-dev-00942 31 07/23/2024
5.0.1 53 06/27/2024
5.0.1-dev-00928 31 07/23/2024
5.0.0 105 02/04/2024
5.0.0-dev-00923 33 07/23/2024
4.2.0-dev-00918 31 07/23/2024
4.1.1-dev-00917 35 07/23/2024
4.1.1-dev-00910 32 07/23/2024
4.1.1-dev-00907 21 07/23/2024
4.1.1-dev-00901 34 07/23/2024
4.1.1-dev-00896 29 07/17/2024
4.1.0 32 07/23/2024
4.1.0-dev-00893 36 07/23/2024
4.0.2-dev-00890 24 07/23/2024
4.0.1 157 02/04/2024
4.0.1-dev-00879 38 07/23/2024
4.0.1-dev-00876 31 07/23/2024
4.0.1-dev-00874 32 07/23/2024
4.0.0 30 07/23/2024
4.0.0-dev-00870 33 07/23/2024
4.0.0-dev-00839 29 07/23/2024
4.0.0-dev-00837 27 07/23/2024
4.0.0-dev-00834 30 07/23/2024
4.0.0-dev-00832 25 07/23/2024
4.0.0-dev-00831 25 07/23/2024
3.1.2-dev-00824 40 07/23/2024
3.1.2-dev-00823 31 07/23/2024
3.1.2-dev-00819 32 07/23/2024
3.1.2-dev-00811 31 07/23/2024
3.1.2-dev-00806 38 07/23/2024
3.1.2-dev-00802 30 07/23/2024
3.1.2-dev-00800 37 07/23/2024
3.1.2-dev-00798 22 07/23/2024
3.1.2-dev-00796 37 07/23/2024
3.1.2-dev-00792 29 07/23/2024
3.1.2-dev-00788 35 07/23/2024
3.1.2-dev-00786 30 07/23/2024
3.1.2-dev-00779 34 07/23/2024
3.1.2-dev-00777 34 07/23/2024
3.1.2-dev-00774 29 07/22/2024
3.1.2-dev-00771 32 07/23/2024
3.1.1 29 07/23/2024
3.1.1-dev-00764 27 07/23/2024
3.1.1-dev-00762 26 07/23/2024
3.1.1-dev-00757 32 07/23/2024
3.1.0 38 07/23/2024
3.0.2-dev-00753 33 07/23/2024
3.0.1 54 02/04/2024
3.0.1-dev-00749 24 07/23/2024
3.0.1-dev-00747 27 07/23/2024
3.0.0 36 07/23/2024
3.0.0-dev-00737 28 07/23/2024
3.0.0-dev-00735 26 07/23/2024
3.0.0-dev-00734 23 07/23/2024
3.0.0-dev-00732 33 07/13/2024
2.2.0-dev-00721 29 07/23/2024
2.2.0-dev-00719 31 07/23/2024
2.1.0 36 07/23/2024
2.1.0-dev-00715 30 07/23/2024
2.1.0-dev-00713 27 07/23/2024
2.0.0 33 07/23/2024
2.0.0-rc-709 27 07/23/2024
2.0.0-beta-707 31 07/23/2024
2.0.0-beta-706 31 07/23/2024
2.0.0-beta-700 33 07/23/2024
2.0.0-beta-513 33 07/23/2024
2.0.0-beta-511 33 07/23/2024
2.0.0-beta-509 25 07/23/2024
2.0.0-beta-507 32 07/23/2024
2.0.0-beta-505 38 07/23/2024
2.0.0-beta-502 41 07/23/2024
2.0.0-beta-499 27 07/23/2024
2.0.0-beta-495 27 07/23/2024
2.0.0-beta-494 39 07/23/2024
2.0.0-beta-493 38 07/23/2024
2.0.0-beta-487 26 07/23/2024
2.0.0-beta-486 36 07/23/2024
2.0.0-beta-479 39 07/23/2024
2.0.0-beta-478 27 07/23/2024
2.0.0-beta-465 32 07/23/2024
2.0.0-beta-456 29 07/23/2024
2.0.0-beta-450 39 07/23/2024
2.0.0-beta-449 37 07/23/2024