Serilog.Sinks.Console 5.0.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Serilog.Sinks.Console --version 5.0.1
NuGet\Install-Package Serilog.Sinks.Console -Version 5.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.Sinks.Console" Version="5.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.Console --version 5.0.1
#r "nuget: Serilog.Sinks.Console, 5.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Sinks.Console as a Cake Addin
#addin nuget:?package=Serilog.Sinks.Console&version=5.0.1

// Install Serilog.Sinks.Console as a Cake Tool
#tool nuget:?package=Serilog.Sinks.Console&version=5.0.1

Serilog.Sinks.Console Build status NuGet Version Documentation Join the chat at https://gitter.im/serilog/serilog 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.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1.3K)

Showing the top 5 NuGet packages that depend on Serilog.Sinks.Console:

Package Downloads
Serilog.AspNetCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Serilog support for ASP.NET Core logging

Serilog.Sinks.ColoredConsole The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Now replaced by Serilog.Sinks.Console, please use that package instead. The colored console sink for Serilog

Serilog.Sinks.Literate The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Now replaced by Serilog.Sinks.Console, please use that package instead. An alternative colored console sink for Serilog that pretty-prints properties.

Pulumi The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The Pulumi .NET SDK lets you write cloud programs in C#, F#, and VB.NET.

IppDotNetSdkForQuickBooksApiV3

The IPP .NET SDK for QuickBooks V3 is a set of .NET classes that make it easier to call QuickBooks APIs. This is the .Net Standard 2.0 version of the .Net SDK

GitHub repositories (353)

Showing the top 5 popular GitHub repositories that depend on Serilog.Sinks.Console:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
netchx/netch
A simple proxy client
abpframework/abp
Open Source Web Application Framework for ASP.NET Core. Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
IdentityServer/IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
microsoft/reverse-proxy
A toolkit for developing high-performance HTTP reverse proxy applications.
Version Downloads Last updated
5.1.0-dev-00943 20,324 3/17/2024
5.0.2-dev-00942 190 3/17/2024
5.0.1 11,400,769 11/28/2023
5.0.1-dev-00928 638 11/28/2023
5.0.0 11,229,595 11/9/2023
5.0.0-dev-00923 48,053 10/12/2023
4.2.0-dev-00918 136,893 7/21/2023
4.1.1-dev-00917 7,166 7/21/2023
4.1.1-dev-00910 262,553 3/14/2023
4.1.1-dev-00907 229,892 2/3/2023
4.1.1-dev-00901 105,768 1/6/2023
4.1.1-dev-00896 399,015 9/27/2022
4.1.0 61,514,787 9/6/2022
4.1.0-dev-00893 993 9/5/2022
4.0.2-dev-00890 482,691 12/22/2021
4.0.1 130,956,064 11/19/2021
4.0.1-dev-00879 79,182 10/21/2021
4.0.1-dev-00876 287,074 8/3/2021
4.0.1-dev-00874 51,774 7/13/2021
4.0.0 20,242,822 7/12/2021
4.0.0-dev-00870 1,116 7/12/2021
4.0.0-dev-00839 4,445,700 1/24/2020
4.0.0-dev-00837 46,423 1/15/2020
4.0.0-dev-00834 703,757 11/22/2019
4.0.0-dev-00832 1,419 11/22/2019
4.0.0-dev-00831 13,655 11/22/2019
3.1.2-dev-00824 518,637 9/13/2019
3.1.2-dev-00823 54,386 8/22/2019
3.1.2-dev-00819 14,128 8/21/2019
3.1.2-dev-00811 21,090 8/15/2019
3.1.2-dev-00806 29,631 8/2/2019
3.1.2-dev-00802 81,653 7/5/2019
3.1.2-dev-00800 53,353 6/24/2019
3.1.2-dev-00798 70,945 5/12/2019
3.1.2-dev-00796 12,417 5/6/2019
3.1.2-dev-00792 80,316 3/14/2019
3.1.2-dev-00788 96,257 1/15/2019
3.1.2-dev-00786 7,700 1/5/2019
3.1.2-dev-00779 230,838 9/22/2018
3.1.2-dev-00777 430,492 5/21/2018
3.1.2-dev-00774 29,242 5/9/2018
3.1.2-dev-00771 17,949 4/29/2018
3.1.1 217,674,131 10/22/2017
3.1.1-dev-00764 1,962 10/22/2017
3.1.1-dev-00762 1,836 10/22/2017
3.1.1-dev-00757 40,103 9/11/2017
3.1.0 818,288 9/11/2017
3.0.2-dev-00753 14,193 8/1/2017
3.0.1 17,188,696 6/23/2017
3.0.1-dev-00749 1,940 6/22/2017
3.0.1-dev-00747 1,958 6/22/2017
3.0.0 219,821 6/21/2017
3.0.0-dev-00737 1,924 6/21/2017
3.0.0-dev-00735 1,909 6/21/2017
3.0.0-dev-00734 1,861 6/19/2017
3.0.0-dev-00732 1,948 6/19/2017
2.2.0-dev-00721 26,070 1/25/2017
2.2.0-dev-00719 4,663 10/25/2016
2.1.0 1,029,071 7/5/2016
2.1.0-dev-00715 1,919 7/5/2016
2.1.0-dev-00713 1,868 7/5/2016
2.0.0 405,031 6/28/2016
2.0.0-rc-709 2,874 5/26/2016
2.0.0-beta-707 2,001 5/17/2016
2.0.0-beta-706 1,786 5/17/2016
2.0.0-beta-700 2,196 3/23/2016
2.0.0-beta-513 1,836 3/15/2016
2.0.0-beta-511 1,819 3/14/2016
2.0.0-beta-509 1,939 3/13/2016
2.0.0-beta-507 2,153 3/1/2016
2.0.0-beta-505 2,212 2/25/2016
2.0.0-beta-502 2,003 2/22/2016
2.0.0-beta-499 1,938 2/21/2016
2.0.0-beta-495 1,893 2/19/2016
2.0.0-beta-494 1,886 2/18/2016
2.0.0-beta-493 1,924 2/18/2016
2.0.0-beta-487 1,835 2/16/2016
2.0.0-beta-486 1,847 2/11/2016
2.0.0-beta-479 1,835 2/9/2016
2.0.0-beta-478 1,863 2/9/2016
2.0.0-beta-465 1,831 1/26/2016
2.0.0-beta-456 1,800 1/20/2016
2.0.0-beta-450 2,109 1/14/2016
2.0.0-beta-449 2,591 1/14/2016