Serilog.AspNetCore 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
.NET 6.0 .NET Standard 2.0 .NET Framework 4.6.2
dotnet add package Serilog.AspNetCore --version 8.0.0
NuGet\Install-Package Serilog.AspNetCore -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.AspNetCore" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.AspNetCore --version 8.0.0
#r "nuget: Serilog.AspNetCore, 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.AspNetCore as a Cake Addin
#addin nuget:?package=Serilog.AspNetCore&version=8.0.0

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

Serilog.AspNetCore Build status NuGet Version NuGet Prerelease Version

Serilog logging for ASP.NET Core. This package routes ASP.NET Core log messages through Serilog, so you can get information about ASP.NET's internal operations written to the same Serilog sinks as your application events.

With Serilog.AspNetCore installed and configured, you can write log messages directly through Serilog or any ILogger interface injected by ASP.NET. All loggers will use the same underlying implementation, levels, and destinations.

.NET Framework and .NET Core 2.x are supported by version 3.4.0 of this package. Recent versions of Serilog.AspNetCore require .NET Core 3.x, .NET 5, or later.


First, install the Serilog.AspNetCore NuGet package into your app.

dotnet add package Serilog.AspNetCore

Next, in your application's Program.cs file, configure Serilog first. A try/catch block will ensure any configuration issues are appropriately logged:

using Serilog;

Log.Logger = new LoggerConfiguration()

    Log.Information("Starting web application");

    var builder = WebApplication.CreateBuilder(args);

    builder.Host.UseSerilog(); // <-- Add this line
    var app = builder.Build();

    app.MapGet("/", () => "Hello World!");

catch (Exception ex)
    Log.Fatal(ex, "Application terminated unexpectedly");

The builder.Host.UseSerilog() call will redirect all log events through your Serilog pipeline.

Finally, clean up by removing the remaining configuration for the default logger, including the "Logging" section from appsettings.*.json files (this can be replaced with Serilog configuration as shown in the Sample project, if required).

That's it! With the level bumped up a little you will see log output resembling:

[22:14:44.646 DBG] RouteCollection.RouteAsync
    Handled? True
[22:14:44.647 DBG] RouterMiddleware.Invoke
    Handled? True
[22:14:45.706 DBG] /lib/jquery/jquery.js not modified
[22:14:45.706 DBG] /css/site.css not modified
[22:14:45.741 DBG] Handled. Status code: 304 File: /css/site.css

Tip: to see Serilog output in the Visual Studio output window when running under IIS, either select ASP.NET Core Web Server from the Show output from drop-down list, or replace WriteTo.Console() in the logger configuration with WriteTo.Debug().

A more complete example, including appsettings.json configuration, can be found in the sample project here.

Request logging

The package includes middleware for smarter HTTP request logging. The default request logging implemented by ASP.NET Core is noisy, with multiple events emitted per request. The included middleware condenses these into a single event that carries method, path, status code, and timing information.

As text, this has a format like:

[16:05:54 INF] HTTP GET / responded 200 in 227.3253 ms

Or as JSON:

  "@t": "2019-06-26T06:05:54.6881162Z",
  "@mt": "HTTP {RequestMethod} {RequestPath} responded {StatusCode} in {Elapsed:0.0000} ms",
  "@r": ["224.5185"],
  "RequestMethod": "GET",
  "RequestPath": "/",
  "StatusCode": 200,
  "Elapsed": 224.5185,
  "RequestId": "0HLNPVG1HI42T:00000001",
  "CorrelationId": null,
  "ConnectionId": "0HLNPVG1HI42T"

To enable the middleware, first change the minimum level for Microsoft.AspNetCore to Warning in your logger configuration or appsettings.json file:

            .MinimumLevel.Override("Microsoft.AspNetCore", LogEventLevel.Warning)

Then, in your application's Program.cs, add the middleware with UseSerilogRequestLogging():

    var app = builder.Build();

    app.UseSerilogRequestLogging(); // <-- Add this line

    // Other app configuration

It's important that the UseSerilogRequestLogging() call appears before handlers such as MVC. The middleware will not time or log components that appear before it in the pipeline. (This can be utilized to exclude noisy handlers from logging, such as UseStaticFiles(), by placing UseSerilogRequestLogging() after them.)

During request processing, additional properties can be attached to the completion event using IDiagnosticContext.Set():

    public class HomeController : Controller
        readonly IDiagnosticContext _diagnosticContext;

        public HomeController(IDiagnosticContext diagnosticContext)
            _diagnosticContext = diagnosticContext ??
                throw new ArgumentNullException(nameof(diagnosticContext));

        public IActionResult Index()
            // The request completion event will carry this property
            _diagnosticContext.Set("CatalogLoadTime", 1423);

            return View();

This pattern has the advantage of reducing the number of log events that need to be constructed, transmitted, and stored per HTTP request. Having many properties on the same event can also make correlation of request details and other data easier.

The following request information will be added as properties by default:

  • RequestMethod
  • RequestPath
  • StatusCode
  • Elapsed

You can modify the message template used for request completion events, add additional properties, or change the event level, using the options callback on UseSerilogRequestLogging():

app.UseSerilogRequestLogging(options =>
    // Customize the message template
    options.MessageTemplate = "Handled {RequestPath}";
    // Emit debug-level events instead of the defaults
    options.GetLevel = (httpContext, elapsed, ex) => LogEventLevel.Debug;
    // Attach additional properties to the request completion event
    options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
        diagnosticContext.Set("RequestHost", httpContext.Request.Host.Value);
        diagnosticContext.Set("RequestScheme", httpContext.Request.Scheme);

Two-stage initialization

The example at the top of this page shows how to configure Serilog immediately when the application starts. This has the benefit of catching and reporting exceptions thrown during set-up of the ASP.NET Core host.

The downside of initializing Serilog first is that services from the ASP.NET Core host, including the appsettings.json configuration and dependency injection, aren't available yet.

To address this, Serilog supports two-stage initialization. An initial "bootstrap" logger is configured immediately when the program starts, and this is replaced by the fully-configured logger once the host has loaded.

To use this technique, first replace the initial CreateLogger() call with CreateBootstrapLogger():

using Serilog;
using Serilog.Events;

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
    .CreateBootstrapLogger(); // <-- Change this line!

Then, pass a callback to UseSerilog() that creates the final logger:

builder.Host.UseSerilog((context, services, configuration) => configuration

It's important to note that the final logger completely replaces the bootstrap logger: if you want both to log to the console, for instance, you'll need to specify WriteTo.Console() in both places, as the example shows.

Consuming appsettings.json configuration

Using two-stage initialization, insert the ReadFrom.Configuration(context.Configuration) call shown in the example above. The JSON configuration syntax is documented in the Serilog.Settings.Configuration README.

Injecting services into enrichers and sinks

Using two-stage initialization, insert the ReadFrom.Services(services) call shown in the example above. The ReadFrom.Services() call will configure the logging pipeline with any registered implementations of the following services:

  • IDestructuringPolicy
  • ILogEventEnricher
  • ILogEventFilter
  • ILogEventSink
  • LoggingLevelSwitch
Enabling Microsoft.Extensions.Logging.ILoggerProviders

Serilog sends events to outputs called sinks, that implement Serilog's ILogEventSink interface, and are added to the logging pipeline using WriteTo. Microsoft.Extensions.Logging has a similar concept called providers, and these implement ILoggerProvider. Providers are what the default logging configuration creates under the hood through methods like AddConsole().

By default, Serilog ignores providers, since there are usually equivalent Serilog sinks available, and these work more efficiently with Serilog's pipeline. If provider support is needed, it can be optionally enabled.

To have Serilog pass events to providers, using two-stage initialization as above, pass writeToProviders: true in the call to UseSerilog():

        (hostingContext, services, loggerConfiguration) => /* snip! */,
        writeToProviders: true)

JSON output

The Console(), Debug(), and File() sinks all support JSON-formatted output natively, via the included Serilog.Formatting.Compact package.

To write newline-delimited JSON, pass a CompactJsonFormatter or RenderedCompactJsonFormatter to the sink configuration method:

    .WriteTo.Console(new RenderedCompactJsonFormatter())

Writing to the Azure Diagnostics Log Stream

The Azure Diagnostic Log Stream ships events from any files in the D:\home\LogFiles\ folder. To enable this for your app, add a file sink to your LoggerConfiguration, taking care to set the shared and flushToDiskInterval parameters:

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
    // Add this line:
       System.IO.Path.Combine(Environment.GetEnvironmentVariable("HOME"), "LogFiles", "Application", "diagnostics.txt"),
       rollingInterval: RollingInterval.Day,
       fileSizeLimitBytes: 10 * 1024 * 1024,
       retainedFileCountLimit: 2,
       rollOnFileSizeLimit: true,
       shared: true,
       flushToDiskInterval: TimeSpan.FromSeconds(1))

Pushing properties to the ILogger<T>

If you want to add extra properties to all log events in a specific part of your code, you can add them to the ILogger<T> in Microsoft.Extensions.Logging with the following code. For this code to work, make sure you have added the .Enrich.FromLogContext() to the .UseSerilog(...) statement, as specified in the samples above.

// Microsoft.Extensions.Logging ILogger<T>
// Yes, it's required to use a dictionary. See
using (logger.BeginScope(new Dictionary<string, object>
    ["UserId"] = "svrooij",
    ["OperationType"] = "update",
   // UserId and OperationType are set for all logging events in these brackets

The code above results in the same outcome as if you would push properties in the ILogger in Serilog.

// Serilog ILogger
using (logger.PushProperty("UserId", "svrooij"))
using (logger.PushProperty("OperationType", "update"))
    // UserId and OperationType are set for all logging events in these brackets


This package tracks the versioning and target framework support of its (indirect) Microsoft.Extensions.Hosting dependency.

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 is compatible.  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 is compatible.  net8.0-android 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 is compatible.  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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1.1K)

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

Package Downloads
Umbraco.Cms.Web.Common The ID prefix of this package has been reserved for one of the owners of this package by

Contains the web assembly needed to run Umbraco CMS.

Umbraco.Cms.Web.BackOffice The ID prefix of this package has been reserved for one of the owners of this package by

Contains the backoffice assembly needed to run the backend of Umbraco CMS.

Umbraco.Cms.Web.Website The ID prefix of this package has been reserved for one of the owners of this package by

Contains the website assembly needed to run the frontend of Umbraco CMS.


Package Description


Package Description

GitHub repositories (251)

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

Repository Stars
The Free Software Media System
Clean Architecture Solution Template: A starting point for Clean Architecture with ASP.NET Core
The core infrastructure backend (API, database, Docker, etc).
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
Open Source Web Application Framework for ASP.NET Core. Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
Version Downloads Last updated
8.0.0 432,531 11/15/2023
8.0.0-dev-00323 74 11/15/2023
7.0.1-dev-00320 26,787 10/11/2023
7.0.0 12,232,200 5/11/2023
7.0.0-dev-00315 189 9/27/2023
7.0.0-dev-00314 176 9/27/2023
7.0.0-dev-00304 525 5/11/2023
7.0.0-dev-00302 3,331 5/5/2023
6.1.1-dev-00295 142,233 2/3/2023
6.1.1-dev-00293 99,821 12/19/2022
6.1.0 27,115,989 11/30/2022
6.1.0-dev-00289 15,894 11/28/2022
6.1.0-dev-00285 142,635 9/27/2022
6.1.0-dev-00281 39,587 8/29/2022
6.0.1 23,253,329 7/18/2022
6.0.1-dev-00280 411 8/29/2022
6.0.1-dev-00275 463 7/18/2022
6.0.0 969,898 7/14/2022
6.0.0-dev-00270 474 7/14/2022
6.0.0-dev-00265 272,783 3/4/2022
5.0.1-dev-00264 3,034 3/4/2022
5.0.1-dev-00262 10,106 2/24/2022
5.0.0 30,497,012 2/15/2022
5.0.0-dev-00259 24,465 2/8/2022
4.1.1-dev-00250 56,571 1/19/2022
4.1.1-dev-00241 184,958 11/12/2021
4.1.1-dev-00229 425,554 6/2/2021
4.1.1-dev-00227 12,676 5/27/2021
4.1.0 58,790,405 3/29/2021
4.1.0-dev-00223 709 3/29/2021
4.0.1-dev-00222 768 3/26/2021
4.0.1-dev-00219 14,260 3/17/2021
4.0.0 3,570,997 3/3/2021
4.0.0-dev-00210 650 3/3/2021
4.0.0-dev-00208 615 3/3/2021
4.0.0-dev-00206 853 3/3/2021
4.0.0-dev-00204 683 3/2/2021
4.0.0-dev-00202 10,277 2/24/2021
4.0.0-dev-00199 9,693 2/17/2021
4.0.0-dev-00198 9,858 2/17/2021
3.4.1-dev-00188 454,120 10/26/2020
3.4.1-dev-00180 358,439 9/15/2020
3.4.0 35,202,118 7/24/2020
3.4.0-dev-00177 789 7/24/2020
3.4.0-dev-00176 719 7/24/2020
3.4.0-dev-00174 778 7/24/2020
3.4.0-dev-00173 175,983 6/18/2020
3.4.0-dev-00171 44,702 6/3/2020
3.4.0-dev-00168 15,541 5/19/2020
3.4.0-dev-00167 6,106 5/13/2020
3.3.0-dev-00161 33,799 5/1/2020
3.3.0-dev-00160 788 5/1/2020
3.3.0-dev-00152 180,708 2/24/2020
3.3.0-dev-00149 63,019 2/19/2020
3.2.1-dev-00147 13,588 2/19/2020
3.2.1-dev-00142 90,549 1/24/2020
3.2.0 37,885,327 11/12/2019
3.2.0-dev-00135 15,306 11/8/2019
3.2.0-dev-00133 2,750 11/6/2019
3.1.1-dev-00132 918 11/6/2019
3.1.0 3,154,825 10/14/2019
3.1.0-dev-00122 11,533 10/7/2019
3.1.0-dev-00119 892 10/7/2019
3.1.0-dev-00118 892 10/7/2019
3.0.1-dev-00116 11,388 10/2/2019
3.0.1-dev-00110 900 10/2/2019
3.0.1-dev-00109 26,278 9/25/2019
3.0.1-dev-00099 59,632 9/3/2019
3.0.0 3,987,812 8/28/2019
3.0.0-dev-00093 1,039 8/27/2019
3.0.0-dev-00088 16,109 8/21/2019
3.0.0-dev-00086 904 8/21/2019
3.0.0-dev-00083 947 8/20/2019
3.0.0-dev-00081 903 8/20/2019
3.0.0-dev-00079 883 8/20/2019
3.0.0-dev-00077 890 8/20/2019
3.0.0-dev-00067 5,122 8/19/2019
3.0.0-dev-00059 42,546 7/19/2019
3.0.0-dev-00058 30,633 6/26/2019
3.0.0-dev-00057 933 6/26/2019
3.0.0-dev-00053 3,839 6/25/2019
3.0.0-dev-00052 1,470 6/25/2019
3.0.0-dev-00046 2,039 6/23/2019
3.0.0-dev-00043 12,235 6/5/2019
3.0.0-dev-00041 1,702 6/3/2019
3.0.0-dev-00040 1,084 6/3/2019
2.1.2-dev-00028 179,261 9/22/2018
2.1.2-dev-00026 55,204 7/19/2018
2.1.2-dev-00024 150,806 5/9/2018
2.1.1 26,468,071 3/7/2018
2.1.1-dev-00022 36,671 1/18/2018
2.1.1-dev-00021 17,578 12/17/2017
2.1.1-dev-00017 6,647 12/3/2017
2.1.0 2,217,476 10/22/2017
2.1.0-dev-00012 1,482 10/16/2017
2.0.1-dev-00011 1,240 10/16/2017
2.0.0 379,745 9/5/2017
2.0.0-dev-00002 4,807 8/29/2017
2.0.0-dev-00001 2,090 8/27/2017