Skip to main content
.NETStandard2.0

Serilog-based logger integration for Rebus

Published
Aug 2, 2023
3y ago
Total Downloads
15.2M
15,213,269

Install

dotnet add package Rebus.Serilog --version 8.0.0-alpha02
ProductVersions
.NET Standard
netstandard2.0

README

Rebus.Serilog

install from nuget

Provides a Serilog logging integration for Rebus.


Do it like this if you just want Rebus to use your global Serilog logger directly:

Configure.With(...)
	.Logging(l => l.Serilog())
	.Transport(t => t.Use(...))
	.(...)
	.Start();

or like this if you want to customize it:

var logger = Log.ForContext("queue", queueName);

Configure.With(...)
	.Logging(l => l.Serilog(logger))
	.Transport(t => t.Use(..., queueName))
	.(...)
	.Start();

Initialize your Serilog logging with Rebus' correlation ID enricher if you'd like the correlation ID of handled messages to be added automatically to all log output generated from message handlers:

Log.Logger = new LoggerConfiguration()
    .WriteTo.(...)
    .Enrich.WithRebusCorrelationId("CorrelationId")
    .CreateLogger();

and then either use real structured logging (e.g. to an aggregator like Elastic), or remember to include it in your output template (here shown with ColoredConsole):

//                                                                                  👇
Log.Logger = new LoggerConfiguration()
	.WriteTo.ColoredConsole(outputTemplate: "{Timestamp:HH:mm:ss} {Level:u3} ({CorrelationId}) {Message}{NewLine}{Exception}")
	.(...)

Changes from Previous Version

No structural changes between v8.0.0-alpha01 and v8.0.0-alpha02.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.Compatibility metadata lists 1 target framework; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.