Serilog.Sinks.Seq 8.0.0

dotnet add package Serilog.Sinks.Seq --version 8.0.0
NuGet\Install-Package Serilog.Sinks.Seq -Version 8.0.0
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.Seq" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.Seq --version 8.0.0
#r "nuget: Serilog.Sinks.Seq, 8.0.0"
#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.Seq as a Cake Addin
#addin nuget:?package=Serilog.Sinks.Seq&version=8.0.0

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

Serilog.Sinks.Seq Build status NuGet

A Serilog sink that writes events to the Seq structured log server. Supports all modern .NET platforms.

<img alt="Package Logo" src="https://datalust.co/images/seq-nuget.png" width="128px">

[!TIP] If you would like to see timing and dependency information in Seq, SerilogTracing is a Serilog extension that supports both logs and traces.

Getting started

Install Serilog.Sinks.Seq into your .NET project:

> dotnet add package Serilog.Sinks.Seq

Point the logger to Seq:

Log.Logger = new LoggerConfiguration()
    .WriteTo.Seq("http://localhost:5341")
    .CreateLogger();

And use the Serilog logging methods to associate named properties with log events:

Log.Error("Failed to log on user {ContactId}", contactId);

Then query log event properties like ContactId from the browser:

Query in Seq

When the application shuts down, ensure any buffered events are propertly flushed to Seq by disposing the logger or calling Log.CloseAndFlush():

Log.CloseAndFlush();

The sink can take advantage of Seq's API keys to authenticate clients and dynamically attach properties to events at the server-side. To use an API key, specify it in the apiKey parameter of WriteTo.Seq().

XML <appSettings> configuration

To adjust the Seq server URL at deployment time, it's often convenient to configure it using XML <appSettings>, in the App.config or Web.config file.

Before Serilog can be configured using XML, the Serilog.Settings.AppSettings package must be installed and enabled using the LoggerConfiguration:

Log.Logger = new LoggerConfiguration()
    .ReadFrom.AppSettings()
    .CreateLogger();

When XML is used for configuration, it's not necessary to include the WriteTo.Seq() method. It is important however that the Serilog.Sinks.Seq.dll assembly is present alongside the app's binaries.

The settings typically included are:

<configuration>
  <appSettings>
    <add key="serilog:using:Seq" value="Serilog.Sinks.Seq" />
    <add key="serilog:write-to:Seq.serverUrl" value="http://localhost:5341" />
    <add key="serilog:write-to:Seq.apiKey" value="[optional API key here]" />

Serilog's XML configuration has several other capabilities that are described on the Serilog wiki.

JSON appsettings.json configuration

To use the Seq 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 Seq 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": "Seq", "Args": { "serverUrl": "http://localhost:5341" } }
    ]
  }
}

See the XML <appSettings> example above for a discussion of available Args options.

Dynamic log level control

The Seq sink can dynamically adjust the logging level up or down based on the level associated with an API key in Seq. To use this feature, create a LoggingLevelSwitch to control the MinimumLevel, and pass this in the controlLevelSwitch parameter of WriteTo.Seq():

var levelSwitch = new LoggingLevelSwitch();

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.ControlledBy(levelSwitch)
    .WriteTo.Seq("http://localhost:5341",
                 apiKey: "yeEZyL3SMcxEKUijBjN",
                 controlLevelSwitch: levelSwitch)
    .CreateLogger();

The equivalent configuration in XML (Serilog 2.6+) is:

<configuration>
  <appSettings>
    
    <add key="serilog:level-switch:$controlSwitch" value="Information" />
    
    <add key="serilog:minimum-level:controlled-by" value="$controlSwitch" />
    <add key="serilog:using:Seq" value="Serilog.Sinks.Seq" />
    <add key="serilog:write-to:Seq.serverUrl" value="http://localhost:5341" />
    <add key="serilog:write-to:Seq.apiKey" value="yeEZyL3SMcxEKUijBjN" />
    
    <add key="serilog:write-to:Seq.controlLevelSwitch" value="$controlSwitch" />

The equivalent configuration in JSON is:

{
    "Serilog":
    {
        "LevelSwitches": { "$controlSwitch": "Information" },
        "MinimumLevel": { "ControlledBy": "$controlSwitch" },
        "WriteTo":
        [{
            "Name": "Seq",
            "Args":
            {
                "serverUrl": "http://localhost:5341",
                "apiKey": "yeEZyL3SMcxEKUijBjN",
                "controlLevelSwitch": "$controlSwitch"
            }
        }]
    }
}

For further information see the Seq documentation.

Troubleshooting

Nothing showed up, what can I do?

If events don't appear in Seq after pressing the refresh button in the filter bar, either your application was unable to contact the Seq server, or else the Seq server rejected the log events for some reason.

Server-side issues

The Seq server may reject incoming events if they're missing a required API key, if the payload is corrupted somehow, or if the log events are too large to accept.

Server-side issues are diagnosed using the Seq Ingestion Log, which shows the details of any problems detected on the server side. The ingestion log is linked from the Settings > Diagnostics page in the Seq user interface.

Client-side issues

If there's no information in the ingestion log, the application was probably unable to reach the server because of network configuration or connectivity issues. These are reported to the application through Serilog's SelfLog.

Add the following line after the logger is configured to print any error information to the console:

Serilog.Debugging.SelfLog.Enable(Console.Error);

If the console is not available, you can pass a delegate into SelfLog.Enable() that will be called with each error message:

Serilog.Debugging.SelfLog.Enable(message => {
    // Do something with `message`
});
Troubleshooting checklist
  • Check the Seq Ingestion Log, as described in the Server-side issues section above.
  • Turn on the Serilog SelfLog as described above to check for connectivity problems and other issues on the client side.
  • Make sure your application calls Log.CloseAndFlush(), or disposes the root Logger, before it exits - otherwise, buffered events may be lost.
  • If your app is a Windows console application, it is also important to close the console window by exiting the app; Windows console apps are terminated "hard" if the close button in the title bar is used, so events buffered for sending to Seq may be lost if you use it.
  • Raise an issue, ask for help on the Seq support forum or email support@datalust.co.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  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 was computed.  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 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  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 (316)

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

Package Downloads
NET6CustomLibrary

open source custom dotnet extension library

Takenet.Iris.Common

Iris common data types package

EtAlii.xTechnology.Diagnostics

A package that contains generic abstractions for debugging and logging purposes.

Hopex.ApplicationServer.SiteModule

Hopex Application site module

MyJetWallet.Sdk.Service

Package Description

GitHub repositories (61)

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

Repository Stars
dotnet/tye
Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.
anjoy8/Blog.Core
💖 ASP.NET Core 8.0 全家桶教程,前后端分离后端接口,vue教程姊妹篇,官方文档:
dotnetcore/Util
Util是一个.Net平台下的应用框架,旨在提升中小团队的开发能力,由工具类、分层架构基类、Ui组件,配套代码生成模板,权限等组成。
fullstackhero/dotnet-starter-kit
Production Grade Cloud-Ready .NET 8 Starter Kit (Web API + Blazor Client) with Multitenancy Support, and Clean/Modular Architecture that saves roughly 200+ Development Hours! All Batteries Included.
skoruba/IdentityServer4.Admin
The administration for the IdentityServer4 and Asp.Net Core Identity
Version Downloads Last updated
8.0.0 105,466 6/4/2024
8.0.0-dev-00305 156 6/3/2024
8.0.0-dev-00302 331 5/29/2024
8.0.0-dev-00299 1,290 5/8/2024
8.0.0-dev-00297 95 5/8/2024
8.0.0-dev-00295 150 5/7/2024
7.0.1 344,974 5/3/2024
7.0.1-dev-00291 56 5/3/2024
7.0.1-dev-00288 149 5/1/2024
7.0.1-dev-00286 5,222 4/1/2024
7.0.0 935,588 3/6/2024
7.0.0-dev-00282 7,298 2/22/2024
7.0.0-dev-00280 78 2/22/2024
7.0.0-dev-00278 85 2/21/2024
7.0.0-dev-00276 9,794 1/2/2024
6.0.0 2,707,669 11/15/2023
6.0.0-dev-00273 114 11/15/2023
6.0.0-dev-00268 2,380 11/3/2023
6.0.0-dev-00266 6,430 10/5/2023
5.2.3 1,263,436 10/4/2023
5.2.3-dev-00262 182,487 2/5/2023
5.2.3-dev-00260 55,396 11/22/2022
5.2.3-dev-00257 2,969 11/15/2022
5.2.2 10,619,513 11/15/2022
5.2.2-dev-00247 8,656 10/18/2022
5.2.1 1,724,308 9/30/2022
5.2.1-dev-00246 161 10/18/2022
5.2.1-dev-00245 158 10/10/2022
5.2.0 665,656 9/13/2022
5.2.0-dev-00239 156 9/28/2022
5.2.0-dev-00236 167 9/13/2022
5.2.0-dev-00234 719 9/13/2022
5.1.2-dev-00232 173 9/12/2022
5.1.2-dev-00229 558 9/12/2022
5.1.2-dev-00225 25,325 6/24/2022
5.1.2-dev-00222 72,925 2/14/2022
5.1.1 10,312,030 1/13/2022
5.1.1-dev-00218 191 1/13/2022
5.1.0 2,202,624 11/12/2021
5.1.0-dev-00214 1,365 11/5/2021
5.1.0-dev-00206 1,032 11/4/2021
5.0.2-dev-00203 315 11/2/2021
5.0.1 8,170,086 4/22/2021
5.0.1-dev-00190 288 4/22/2021
5.0.0 1,985,070 2/11/2021
5.0.0-dev-00184 306 2/11/2021
5.0.0-dev-00174 148,512 2/23/2020
5.0.0-dev-00172 34,101 2/17/2020
4.1.0-dev-00166 498,788 10/17/2019
4.0.1-dev-00159 95,962 9/22/2018
4.0.1-dev-00157 20,500 7/23/2018
4.0.1-dev-00155 18,678 5/9/2018
4.0.1-dev-00154 2,922 4/13/2018
4.0.0 23,120,886 1/14/2018
4.0.0-dev-00150 11,019 10/30/2017
4.0.0-dev-00148 1,461 10/19/2017
3.4.0 1,514,598 9/18/2017
3.4.0-dev-00134 3,164 9/15/2017
3.3.4-dev-00129 4,481 7/27/2017
3.3.4-dev-00126 942 7/26/2017
3.3.3 219,484 7/25/2017
3.3.3-dev-00122 954 7/25/2017
3.3.2 66,661 6/20/2017
3.3.2-dev-00118 995 6/20/2017
3.3.1 64,080 5/22/2017
3.3.1-dev-00114 983 5/22/2017
3.3.0 13,834 5/18/2017
3.3.0-dev-00110 3,750 4/8/2017
3.2.0 450,797 1/6/2017
3.2.0-dev-00105 1,028 1/6/2017
3.1.2-dev-00103 996 1/6/2017
3.1.2-dev-00100 2,688 11/15/2016
3.1.1 198,975 11/4/2016
3.1.1-dev-00096 1,189 11/4/2016
3.1.0 16,160 11/4/2016
3.1.0-dev-00092 1,282 11/4/2016
3.1.0-dev-00090 1,254 11/3/2016
3.0.2-dev-00088 1,061 10/31/2016
3.0.2-dev-00086 2,851 10/4/2016
3.0.1 158,145 9/9/2016
3.0.1-dev-00082 952 9/9/2016
3.0.0 42,510 8/26/2016
3.0.0-dev-00077 1,006 8/26/2016
3.0.0-dev-00076 1,018 8/21/2016
3.0.0-dev-00071 1,080 8/18/2016
3.0.0-dev-00069 5,321 7/7/2016
3.0.0-dev-00067 1,041 7/7/2016
2.0.1 93,908 8/21/2016
2.0.1-dev-00065 1,146 7/5/2016
2.0.0 112,943 6/28/2016
2.0.0-rc-57 1,900 6/20/2016
2.0.0-rc-55 1,167 6/17/2016
2.0.0-rc-51 1,323 6/9/2016
2.0.0-rc-48 1,586 6/1/2016
2.0.0-rc-46 2,656 5/17/2016
2.0.0-beta-42 3,800 3/3/2016
2.0.0-beta-41 993 3/3/2016
2.0.0-beta-39 971 3/3/2016
2.0.0-beta-38 1,283 2/28/2016
2.0.0-beta-34 1,760 2/23/2016
2.0.0-beta-33 1,539 2/15/2016
2.0.0-beta-32 986 2/15/2016
2.0.0-beta-31 1,062 2/9/2016
2.0.0-beta-30 1,724 1/26/2016
2.0.0-beta-29 974 1/26/2016
2.0.0-beta-28 1,282 1/14/2016
2.0.0-beta-25 1,376 12/1/2015
2.0.0-beta-23 1,243 11/28/2015
2.0.0-beta-22 1,217 11/28/2015
1.5.36 82,187 2/25/2016
1.5.27 48,669 12/6/2015
1.5.24 2,755 12/1/2015
1.5.17 76,401 9/4/2015
1.5.15 53,703 6/23/2015
1.5.14 16,898 4/30/2015
1.5.11 2,618 4/26/2015
1.5.9 4,925 4/10/2015
1.5.8 1,348 4/10/2015
1.5.7 2,186 4/2/2015
1.5.6 1,531 4/1/2015
1.5.5 1,971 3/26/2015
1.5.4 4,041 3/11/2015
1.5.3 1,344 3/11/2015
1.5.2 1,351 3/11/2015
1.5.1 1,942 3/11/2015
1.4.196 4,535 2/22/2015
1.4.182 3,229 2/15/2015
1.4.168 1,895 2/8/2015
1.4.155 2,150 2/1/2015
1.4.139 3,774 1/23/2015
1.4.118 2,048 1/13/2015
1.4.113 2,797 1/6/2015
1.4.102 3,912 12/21/2014
1.4.99 1,792 12/18/2014
1.4.97 1,602 12/18/2014
1.4.76 4,108 12/8/2014
1.4.39 1,947 11/26/2014
1.4.34 1,680 11/24/2014
1.4.28 1,515 11/24/2014
1.4.27 1,535 11/23/2014
1.4.23 1,529 11/21/2014
1.4.21 1,488 11/21/2014
1.4.18 1,797 11/18/2014
1.4.15 3,689 11/4/2014
1.4.14 1,723 10/23/2014
1.4.13 1,330 10/23/2014
1.4.12 3,230 10/12/2014
1.4.11 1,517 10/8/2014
1.4.10 6,910 9/26/2014
1.4.9 1,664 9/17/2014
1.4.8 1,675 9/11/2014
1.4.7 1,857 9/1/2014
1.4.6 1,382 8/31/2014
1.4.5 1,410 8/27/2014
1.4.4 35,509 8/27/2014