Serilog.Sinks.Seq 7.0.0-dev-00280

This is a prerelease version of Serilog.Sinks.Seq.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Serilog.Sinks.Seq --version 7.0.0-dev-00280
                    
NuGet\Install-Package Serilog.Sinks.Seq -Version 7.0.0-dev-00280
                    
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="7.0.0-dev-00280" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Serilog.Sinks.Seq" Version="7.0.0-dev-00280" />
                    
Directory.Packages.props
<PackageReference Include="Serilog.Sinks.Seq" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Serilog.Sinks.Seq --version 7.0.0-dev-00280
                    
#r "nuget: Serilog.Sinks.Seq, 7.0.0-dev-00280"
                    
#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.
#addin nuget:?package=Serilog.Sinks.Seq&version=7.0.0-dev-00280&prerelease
                    
Install Serilog.Sinks.Seq as a Cake Addin
#tool nuget:?package=Serilog.Sinks.Seq&version=7.0.0-dev-00280&prerelease
                    
Install Serilog.Sinks.Seq as a Cake Tool

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">

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.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 (364)

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

Package Downloads
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

Convey.Logging

Convey.Logging

MyJetWallet.Sdk.Service

Package Description

GitHub repositories (73)

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

Repository Stars
fullstackhero/dotnet-starter-kit
Production Grade Cloud-Ready .NET 9 Starter Kit (Web API + Blazor Client) with Multitenancy Support, and Clean/Modular Architecture that saves roughly 200+ Development Hours! All Batteries Included.
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组件,配套代码生成模板,权限等组成。
skoruba/IdentityServer4.Admin
The administration for the IdentityServer4 and Asp.Net Core Identity
ChangemakerStudios/Papercut-SMTP
Papercut SMTP -- The Simple Desktop Email Server
vietnam-devs/coolstore-microservices
A full-stack .NET microservices build on Dapr and Tye
AppMetrics/AppMetrics
App Metrics is an open-source and cross-platform .NET library used to record and report metrics within an application.
asynkron/protoactor-dotnet
Proto Actor - Ultra fast distributed actors for Go, C# and Java/Kotlin
dotnet-architecture/eShopOnDapr
A sample .NET distributed application based on eShopOnContainers, powered by Dapr.
desenvolvedor-io/dev-store
A microservices e-commerce reference application built with ASP.NET 6
meysamhadeli/monolith-to-cloud-architecture
A practical architecture styles for migrating from monolith to modern cloud native application with the latest technologies and architectures like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, and Masstransit in .Net 9.
neozhu/CleanArchitectureWithBlazorServer
This is a repository for creating a Blazor Server dashboard application following the principles of Clean Architecture
snatch-dev/Convey
A simple recipe for .NET Core microservices.
bing-framework/Bing.NetCore
Bing是基于 .net core 3.1 的框架,旨在提升团队的开发输出能力,由常用公共操作类(工具类、帮助类)、分层架构基类,第三方组件封装,第三方业务接口封装等组成。
CodeMazeBlog/CodeMazeGuides
The main repository for all the Code Maze guides
Mimetis/Dotmim.Sync
A brand new database synchronization framework, multi platform, multi databases, developed on top of .Net Standard 2.0. https://dotmimsync.readthedocs.io/
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
davidfowl/Micronetes
Micronetes is a local orchestrator inspired by kubernetes that makes developing and testing microservices and distributed applications easier.
Aguafrommars/TheIdServer
OpenID/Connect, OAuth2, WS-Federation and SAML 2.0 server based on Duende IdentityServer and ITFoxtec Identity SAML 2.0 with its admin UI
Version Downloads Last updated
9.0.0 1,534,742 12/20/2024
9.0.0-dev-02304 153 12/20/2024
9.0.0-dev-02303 157 12/20/2024
9.0.0-dev-02301 6,124 12/2/2024
9.0.0-dev-00310 21,324 7/21/2024
8.0.1-dev-00309 482 7/21/2024
8.0.0 7,835,631 6/4/2024
8.0.0-dev-00305 310 6/3/2024
8.0.0-dev-00302 503 5/29/2024
8.0.0-dev-00299 3,918 5/8/2024
8.0.0-dev-00297 197 5/8/2024
8.0.0-dev-00295 572 5/7/2024
7.0.1 1,367,006 5/3/2024
7.0.1-dev-00291 157 5/3/2024
7.0.1-dev-00288 2,710 5/1/2024
7.0.1-dev-00286 16,332 4/1/2024
7.0.0 2,256,239 3/6/2024
7.0.0-dev-00282 13,464 2/22/2024
7.0.0-dev-00280 193 2/22/2024
7.0.0-dev-00278 208 2/21/2024
7.0.0-dev-00276 19,109 1/2/2024
6.0.0 5,543,226 11/15/2023
6.0.0-dev-00273 205 11/15/2023
6.0.0-dev-00268 3,491 11/3/2023
6.0.0-dev-00266 10,118 10/5/2023
5.2.3 2,303,324 10/4/2023
5.2.3-dev-00262 207,581 2/5/2023
5.2.3-dev-00260 73,131 11/22/2022
5.2.3-dev-00257 3,205 11/15/2022
5.2.2 14,077,591 11/15/2022
5.2.2-dev-00247 9,194 10/18/2022
5.2.1 2,042,655 9/30/2022
5.2.1-dev-00246 248 10/18/2022
5.2.1-dev-00245 244 10/10/2022
5.2.0 843,461 9/13/2022
5.2.0-dev-00239 253 9/28/2022
5.2.0-dev-00236 266 9/13/2022
5.2.0-dev-00234 819 9/13/2022
5.1.2-dev-00232 261 9/12/2022
5.1.2-dev-00229 998 9/12/2022
5.1.2-dev-00225 28,742 6/24/2022
5.1.2-dev-00222 85,951 2/14/2022
5.1.1 12,705,014 1/13/2022
5.1.1-dev-00218 284 1/13/2022
5.1.0 2,535,492 11/12/2021
5.1.0-dev-00214 1,447 11/5/2021
5.1.0-dev-00206 1,118 11/4/2021
5.0.2-dev-00203 401 11/2/2021
5.0.1 9,185,955 4/22/2021
5.0.1-dev-00190 380 4/22/2021
5.0.0 2,275,177 2/11/2021
5.0.0-dev-00184 400 2/11/2021
5.0.0-dev-00174 156,436 2/23/2020
5.0.0-dev-00172 34,217 2/17/2020
4.1.0-dev-00166 514,873 10/17/2019
4.0.1-dev-00159 100,058 9/22/2018
4.0.1-dev-00157 20,777 7/23/2018
4.0.1-dev-00155 19,546 5/9/2018
4.0.1-dev-00154 3,145 4/13/2018
4.0.0 24,977,136 1/14/2018
4.0.0-dev-00150 11,509 10/30/2017
4.0.0-dev-00148 1,624 10/19/2017
3.4.0 1,755,268 9/18/2017
3.4.0-dev-00134 3,338 9/15/2017
3.3.4-dev-00129 4,677 7/27/2017
3.3.4-dev-00126 1,112 7/26/2017
3.3.3 231,474 7/25/2017
3.3.3-dev-00122 1,110 7/25/2017
3.3.2 70,331 6/20/2017
3.3.2-dev-00118 1,159 6/20/2017
3.3.1 65,784 5/22/2017
3.3.1-dev-00114 1,145 5/22/2017
3.3.0 14,205 5/18/2017
3.3.0-dev-00110 3,934 4/8/2017
3.2.0 463,710 1/6/2017
3.2.0-dev-00105 1,195 1/6/2017
3.1.2-dev-00103 1,154 1/6/2017
3.1.2-dev-00100 2,860 11/15/2016
3.1.1 219,099 11/4/2016
3.1.1-dev-00096 1,351 11/4/2016
3.1.0 17,406 11/4/2016
3.1.0-dev-00092 1,468 11/4/2016
3.1.0-dev-00090 1,434 11/3/2016
3.0.2-dev-00088 1,224 10/31/2016
3.0.2-dev-00086 3,026 10/4/2016
3.0.1 167,697 9/9/2016
3.0.1-dev-00082 1,122 9/9/2016
3.0.0 50,965 8/26/2016
3.0.0-dev-00077 1,191 8/26/2016
3.0.0-dev-00076 1,183 8/21/2016
3.0.0-dev-00071 1,247 8/18/2016
3.0.0-dev-00069 5,493 7/7/2016
3.0.0-dev-00067 1,233 7/7/2016
2.0.1 96,656 8/21/2016
2.0.1-dev-00065 1,324 7/5/2016
2.0.0 116,754 6/28/2016
2.0.0-rc-57 2,183 6/20/2016
2.0.0-rc-55 1,335 6/17/2016
2.0.0-rc-51 1,492 6/9/2016
2.0.0-rc-48 1,761 6/1/2016
2.0.0-rc-46 2,832 5/17/2016
2.0.0-beta-42 3,977 3/3/2016
2.0.0-beta-41 1,172 3/3/2016
2.0.0-beta-39 1,138 3/3/2016
2.0.0-beta-38 1,447 2/28/2016
2.0.0-beta-34 1,923 2/23/2016
2.0.0-beta-33 1,703 2/15/2016
2.0.0-beta-32 1,146 2/15/2016
2.0.0-beta-31 1,218 2/9/2016
2.0.0-beta-30 1,886 1/26/2016
2.0.0-beta-29 1,134 1/26/2016
2.0.0-beta-28 1,452 1/14/2016
2.0.0-beta-25 1,545 12/1/2015
2.0.0-beta-23 1,412 11/28/2015
2.0.0-beta-22 1,390 11/28/2015
1.5.36 92,833 2/25/2016
1.5.27 56,975 12/6/2015
1.5.24 2,950 12/1/2015
1.5.17 82,702 9/4/2015
1.5.15 54,585 6/23/2015
1.5.14 17,166 4/30/2015
1.5.11 2,801 4/26/2015
1.5.9 5,115 4/10/2015
1.5.8 1,543 4/10/2015
1.5.7 2,395 4/2/2015
1.5.6 1,719 4/1/2015
1.5.5 2,186 3/26/2015
1.5.4 4,222 3/11/2015
1.5.3 1,527 3/11/2015
1.5.2 1,524 3/11/2015
1.5.1 2,219 3/11/2015
1.4.196 4,916 2/22/2015
1.4.182 3,412 2/15/2015
1.4.168 2,085 2/8/2015
1.4.155 2,320 2/1/2015
1.4.139 4,068 1/23/2015
1.4.118 2,258 1/13/2015
1.4.113 3,000 1/6/2015
1.4.102 4,071 12/21/2014
1.4.99 1,974 12/18/2014
1.4.97 1,779 12/18/2014
1.4.76 4,397 12/8/2014
1.4.39 2,137 11/26/2014
1.4.34 1,861 11/24/2014
1.4.28 1,692 11/24/2014
1.4.27 1,708 11/23/2014
1.4.23 1,699 11/21/2014
1.4.21 1,659 11/21/2014
1.4.18 1,986 11/18/2014
1.4.15 3,921 11/4/2014
1.4.14 1,893 10/23/2014
1.4.13 1,491 10/23/2014
1.4.12 3,393 10/12/2014
1.4.11 1,679 10/8/2014
1.4.10 7,084 9/26/2014
1.4.9 1,827 9/17/2014
1.4.8 1,845 9/11/2014
1.4.7 2,024 9/1/2014
1.4.6 1,533 8/31/2014
1.4.5 1,575 8/27/2014
1.4.4 60,579 8/27/2014