.NET Core Middleware for Serilog Logging

Logging is an important part of software development because it allows developers to properly monitor and troubleshoot applications. Serilog is a popular choice for logging in the.NET Core ecosystem due to its versatility and extensibility. Serilog allows programmers to capture and store log events in a variety of formats and locations. In this article, we'll look at how to configure.NET Core middleware for logging using Serilog.

What exactly is Serilog?

Serilog is a robust.NET logging framework that provides organized and configurable logging capabilities. Serilog, unlike standard logging frameworks, encourages developers to log structured data, which makes it easier to access and analyze logs afterward. Serilog supports a diverse set of sinks (output destinations) for log data, including text files, databases, and third-party services such as Elasticsearch, making it a viable alternative for logging in.NET applications.

Creating a.NET Core Project
A.NET Core project is required to get started with Serilog. You can make one by running the command below.

dotnet new console -n MyLoggerApp
cd MyLoggerApp

Next, you need to add Serilog and the Serilog.Extensions.Logging package to your project. You can do this using the following commands:

dotnet add package Serilog dotnet
add package Serilog.Extensions.Logging

Configuring Serilog

After adding the required packages, you'll need to configure Serilog in your application. Create a Program.cs file or update the existing one with the following code.

using System;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Serilog;

class Program
{
    static void Main()
    {
        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .CreateLogger();

        var serviceProvider = new ServiceCollection()
            .AddLogging(builder =>
            {
                builder.ClearProviders();
                builder.AddSerilog();
            })
            .BuildServiceProvider();

        var logger = serviceProvider.GetService<ILogger<Program>>();
        logger.LogInformation("Hello, Serilog!");

        // Your application logic here...

        Log.CloseAndFlush();
    }
}

In this configuration, we create a Serilog logger and configure it to write log events to the console. We then set up a ServiceProvider to add Serilog as the logging provider for the application.

Adding Middleware for Logging

Middleware is an essential part of a .NET Core application, allowing you to handle requests and responses in a modular way. To add Serilog-based logging middleware, open your Startup.cs file and update the Configure method as follows.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
        app.UseHsts();
    }

    // Add Serilog logging middleware here
    app.UseSerilogRequestLogging();

    app.UseHttpsRedirection();
    app.UseStaticFiles();
    app.UseRouting();
    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
    });
}

By calling app.UseSerilogRequestLogging(), you are adding Serilog-based middleware that logs information about incoming HTTP requests and outgoing responses. This middleware helps you track requests and responses, making it easier to diagnose issues in your web application.

Customizing Serilog Configuration

Serilog's power lies in its flexibility. You can customize its configuration to log to different sinks, enrich log events, and more. For example, to log to a file instead of the console, you can modify the logger configuration as follows.

Log.Logger = new LoggerConfiguration()
    .WriteTo.File("log.txt")
    .CreateLogger();

Additionally, you can enhance log events with contextual information using Serilog's enrichers, and you can set different log levels for different parts of your application. 

Best ASP.NET Core 8.0 Hosting Recommendation

One of the most important things when choosing a good ASP.NET Core 8.0 hosting is the feature and reliability. HostForLIFE is the leading provider of Windows hosting and affordable ASP.NET Core, their servers are optimized for PHP web applications. The performance and the uptime of the hosting service are excellent and the features of the web hosting plan are even greater than what many hosting providers ask you to pay for. 

At HostForLIFEASP.NET, customers can also experience fast ASP.NET Core hosting. The company invested a lot of money to ensure the best and fastest performance of the datacenters, servers, network and other facilities. Its datacenters are equipped with the top equipments like cooling system, fire detection, high speed Internet connection, and so on. That is why HostForLIFEASP.NET guarantees 99.9% uptime for ASP.NET Core. And the engineers do regular maintenance and monitoring works to assure its Orchard hosting are security and always up.