Serilog.Enrichers.Thread 4.0.0-dev-00770

Serilog.Enrichers.Thread Build status NuGet Version

Enrich Serilog events with properties from the current thread.

Getting started

Install the package from NuGet:

Install-Package Serilog.Enrichers.Thread

In your logger configuration, apply Enrich.WithThreadId() and Enrich.WithThreadName():

Log.Logger = new LoggerConfiguration()
    .Enrich.WithThreadId()
    .Enrich.WithThreadName()
    .CreateLogger();

Many sinks simply include all properties without further action required, so the thread id will be logged automatically. However, some sinks, such as the File and Console sinks use an output template and the new ThreadId may not be automatically output in your sink. In this case, in order for the ThreadId or ThreadName to show up in the logging, you will need to create or modify your output template.

w.File(...., outputTemplate:
  "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj} {Properties}{NewLine}{Exception}")

Here, {Properties} can include not only ThreadId and ThreadName, but any other enrichment which is applied. Alternatively, {ThreadId} could be used instead, if you want to only add the thread id enrichment and {ThreadName}, if you want to only add the thread name enrichment.

An example, which also uses the Serilogs.Sinks.Async Nuget package, is below:

            Thread.CurrentThread.Name = "MyWorker";
              
            var logger = Log.Logger = new LoggerConfiguration()
                 .MinimumLevel.Debug()
                 .WriteTo.Console(restrictedToMinimumLevel:Serilog.Events.LogEventLevel.Information)
                 .WriteTo.Async(w=>w.File("..\\..\\..\\..\\logs\\SerilogLogFile.json", rollingInterval: RollingInterval.Day, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj} <{ThreadId}><{ThreadName}>{NewLine}{Exception}"))
                 .Enrich.WithThreadId()
                 .CreateLogger();

Which would produce an output in the log file as follows:

2018-04-06 13:12:45.684 +02:00 [ERR] The file file_name.svg does not exist <4><MyWorker>

Where, <4> is an example thread id and <MyWorker> is an example thread name.

To use the enricher, first install the NuGet package:

Install-Package Serilog.Enrichers.Thread

Note: The {ThreadName} property will only be attached when it is not null. Otherwise it will be omitted. If you want to get this property always attached you can use the following:

using Serilog.Enrichers;

Log.Logger = new LoggerConfiguration()
    .Enrich.WithThreadName()
    .Enrich.WithProperty(ThreadNameEnricher.ThreadNamePropertyName, "MyDefault")
    .CreateLogger();

The enrichment order is important. Otherwise "MyDefault" would always win.

Copyright © 2016 Serilog Contributors - Provided under the Apache License, Version 2.0.

Showing the top 20 packages that depend on Serilog.Enrichers.Thread.

Packages Downloads
NBomber
Modern and flexible load testing framework for Pull and Push scenarios, designed to test any system regardless a protocol (HTTP/WebSockets/AMQP etc) or a semantic model (Pull/Push).
16
NBomber
Modern and flexible load testing framework for Pull and Push scenarios, designed to test any system regardless a protocol (HTTP/WebSockets/AMQP etc) or a semantic model (Pull/Push).
15
NBomber
Very simple load testing framework for Pull and Push scenarios.
15
NBomber
Modern and flexible load testing framework for Pull and Push scenarios, designed to test any system regardless a protocol (HTTP/WebSockets/AMQP etc) or a semantic model (Pull/Push).
14

.NET Framework 4.6.2

.NET Framework 4.7.1

.NET 6.0

.NET 8.0

.NET Standard 2.0

Version Downloads Last updated
4.0.0 20 11/03/2024
4.0.0-dev-00770 13 11/09/2024
4.0.0-dev-00767 14 11/23/2024
4.0.0-dev-00762 15 11/29/2024
3.2.0-dev-00756 15 11/21/2024
3.2.0-dev-00752 13 10/27/2024
3.2.0-dev-00750 14 10/19/2024
3.2.0-dev-00747 12 11/29/2024
3.1.1-dev-00745 12 11/29/2024
3.1.1-dev-00743 11 11/29/2024
3.1.0 14 11/12/2024
3.1.0-dev-00739 10 11/29/2024
3.0.1-dev-00737 14 11/14/2024
3.0.1-dev-00731 10 11/07/2024
3.0.1-dev-00728 12 11/19/2024
3.0.1-dev-00727 9 11/29/2024
3.0.0 12 11/29/2024
3.0.0-dev-00721 13 11/29/2024
2.0.1-dev-00720 9 11/29/2024
2.0.0 13 11/12/2024
2.0.0-rc-712 10 10/29/2024
2.0.0-beta-705 14 11/29/2024
2.0.0-beta-701 16 11/14/2024
2.0.0-beta-700 10 10/31/2024
2.0.0-beta-521 11 11/18/2024
2.0.0-beta-519 13 11/12/2024
2.0.0-beta-516 15 11/29/2024
2.0.0-beta-515 10 11/11/2024
2.0.0-beta-513 10 11/12/2024
2.0.0-beta-511 13 11/08/2024
2.0.0-beta-509 15 10/29/2024
2.0.0-beta-507 11 11/07/2024
2.0.0-beta-505 10 11/20/2024
2.0.0-beta-502 12 11/19/2024
2.0.0-beta-499 17 11/21/2024