Serilog.Sinks.Seq 8.0.0-dev-00305

Serilog.Sinks.Seq Build status NuGet

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

Package Logo

[!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>
    <!-- declare the switch -->
    <add key="serilog:level-switch:$controlSwitch" value="Information" />
    <!-- use it to control the root logger -->
    <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" />
    <!-- give the sink access to the switch -->
    <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.

Showing the top 20 packages that depend on Serilog.Sinks.Seq.

Packages Downloads
Convey.Logging
Convey.Logging
14
Convey.Logging
Convey.Logging
13
Convey.Logging
Convey.Logging
12

.NET 6.0

.NET Standard 2.0

Version Downloads Last updated
9.0.0 10 01/23/2025
9.0.0-dev-02304 7 01/21/2025
9.0.0-dev-02303 41 01/21/2025
9.0.0-dev-02301 11 01/21/2025
9.0.0-dev-00310 14 09/30/2024
8.0.1-dev-00309 14 11/23/2024
8.0.0 20 10/02/2024
8.0.0-dev-00305 13 11/23/2024
8.0.0-dev-00302 13 10/06/2024
8.0.0-dev-00299 13 10/05/2024
8.0.0-dev-00297 11 10/04/2024
8.0.0-dev-00295 12 11/23/2024
7.0.1 12 09/30/2024
7.0.1-dev-00291 14 10/06/2024
7.0.1-dev-00288 10 11/23/2024
7.0.1-dev-00286 13 10/06/2024
7.0.0 15 06/16/2024
7.0.0-dev-00282 13 10/06/2024
7.0.0-dev-00280 9 10/03/2024
7.0.0-dev-00278 8 10/06/2024
7.0.0-dev-00276 13 10/06/2024
6.0.0 12 03/17/2024
6.0.0-dev-00273 13 10/06/2024
6.0.0-dev-00268 12 10/07/2024
6.0.0-dev-00266 11 10/06/2024
5.2.3 12 10/03/2024
5.2.3-dev-00262 11 10/06/2024
5.2.3-dev-00260 13 12/02/2022
5.2.3-dev-00257 13 10/06/2024
5.2.2 14 12/02/2022
5.2.2-dev-00247 11 10/06/2024
5.2.1 11 10/04/2024
5.2.1-dev-00246 14 10/06/2024
5.2.1-dev-00245 14 10/03/2024
5.2.0 14 10/06/2024
5.2.0-dev-00239 13 11/23/2024
5.2.0-dev-00236 13 11/23/2024
5.2.0-dev-00234 13 10/03/2024
5.1.2-dev-00232 13 10/06/2024
5.1.2-dev-00229 13 10/04/2024
5.1.2-dev-00225 12 10/06/2024
5.1.2-dev-00222 11 10/04/2024
5.1.1 101 01/25/2022
5.1.1-dev-00218 14 10/06/2024
5.1.0 13 10/04/2024
5.1.0-dev-00214 13 10/06/2024
5.1.0-dev-00206 13 10/04/2024
5.0.2-dev-00203 12 11/23/2024
5.0.1 144 12/07/2021
5.0.1-dev-00190 12 11/23/2024
5.0.0 46 11/30/2021
5.0.0-dev-00184 12 10/03/2024
5.0.0-dev-00174 11 10/04/2024
5.0.0-dev-00172 13 10/04/2024
4.1.0-dev-00166 13 11/23/2024
4.0.1-dev-00159 13 11/23/2024
4.0.1-dev-00157 13 10/04/2024
4.0.1-dev-00155 12 10/06/2024
4.0.1-dev-00154 13 10/06/2024
4.0.0 13 10/03/2024
4.0.0-dev-00150 12 10/06/2024
4.0.0-dev-00148 11 11/23/2024
3.4.0 9 10/06/2024
3.4.0-dev-00134 8 10/03/2024
3.3.4-dev-00129 14 10/06/2024
3.3.4-dev-00126 12 11/23/2024
3.3.3 13 10/06/2024
3.3.3-dev-00122 13 10/06/2024
3.3.2 12 11/21/2024
3.3.2-dev-00118 9 10/06/2024
3.3.1 12 10/06/2024
3.3.1-dev-00114 10 10/26/2024
3.3.0 10 10/04/2024
3.3.0-dev-00110 10 11/23/2024
3.2.0 13 10/06/2024
3.2.0-dev-00105 12 10/07/2024
3.1.2-dev-00103 13 10/04/2024
3.1.2-dev-00100 9 10/06/2024
3.1.1 9 10/05/2024
3.1.1-dev-00096 14 10/04/2024
3.1.0 13 11/21/2024
3.1.0-dev-00092 13 10/06/2024
3.1.0-dev-00090 13 10/06/2024
3.0.2-dev-00088 10 10/04/2024
3.0.2-dev-00086 14 10/03/2024
3.0.1 12 11/21/2024
3.0.1-dev-00082 12 11/23/2024
3.0.0 13 10/06/2024
3.0.0-dev-00077 12 11/23/2024
3.0.0-dev-00076 8 10/06/2024
3.0.0-dev-00071 12 11/23/2024
3.0.0-dev-00069 11 10/03/2024
3.0.0-dev-00067 10 10/02/2024
2.0.1 9 11/21/2024
2.0.1-dev-00065 11 11/23/2024
2.0.0 13 10/06/2024
2.0.0-rc-57 13 10/27/2024
2.0.0-rc-55 13 10/05/2024
2.0.0-rc-51 11 11/22/2024
2.0.0-rc-48 8 10/06/2024
2.0.0-rc-46 14 10/06/2024
2.0.0-beta-42 9 11/17/2024
2.0.0-beta-41 13 11/17/2024
2.0.0-beta-39 12 10/04/2024
2.0.0-beta-38 11 10/06/2024
2.0.0-beta-34 13 10/06/2024
2.0.0-beta-33 10 10/06/2024
2.0.0-beta-32 10 10/06/2024
2.0.0-beta-31 13 11/17/2024
2.0.0-beta-30 12 11/17/2024
2.0.0-beta-29 11 10/03/2024
2.0.0-beta-28 13 10/03/2024
2.0.0-beta-25 8 10/06/2024
2.0.0-beta-23 13 10/06/2024
2.0.0-beta-22 13 10/04/2024
1.5.36 14 10/06/2024
1.5.27 13 10/05/2024
1.5.24 13 10/04/2024
1.5.17 13 10/06/2024
1.5.15 13 10/06/2024
1.5.14 12 10/06/2024
1.5.11 12 10/06/2024
1.5.9 13 10/06/2024
1.5.8 10 10/06/2024
1.5.7 8 11/21/2024
1.5.6 8 11/21/2024
1.5.5 11 11/17/2024
1.5.4 13 10/03/2024
1.5.3 11 10/06/2024
1.5.2 13 10/06/2024
1.5.1 12 10/06/2024
1.4.196 12 11/21/2024
1.4.182 13 10/06/2024
1.4.168 12 11/21/2024
1.4.155 11 11/21/2024
1.4.139 13 10/06/2024
1.4.118 13 10/06/2024
1.4.113 12 11/21/2024
1.4.102 9 10/05/2024
1.4.99 12 11/21/2024
1.4.97 10 10/06/2024
1.4.76 14 10/06/2024
1.4.39 13 10/06/2024
1.4.34 12 11/21/2024
1.4.28 13 10/04/2024
1.4.27 12 11/21/2024
1.4.23 12 10/01/2024
1.4.21 13 10/06/2024
1.4.18 13 10/06/2024
1.4.15 0 11/04/2014
1.4.14 0 10/23/2014
1.4.13 0 10/23/2014
1.4.12 0 10/12/2014
1.4.11 0 10/08/2014
1.4.10 0 09/26/2014
1.4.9 0 09/17/2014
1.4.8 0 09/11/2014
1.4.7 0 09/01/2014
1.4.6 0 08/31/2014
1.4.5 0 08/27/2014
1.4.4 0 08/27/2014