Logging ASP.NET Core Applications with Serilog and SQL Server

8 August 2024

Introduction

When building web applications using ASP.NET Core, logging is an essential aspect of monitoring and debugging. While the built-in logging mechanisms in ASP.NET Core are robust, sometimes you need more flexibility, especially when it comes to storing logs centrally or integrating with other systems. One powerful solution for this is Serilog, a third-party logging library that can be easily integrated into your ASP.NET Core project.

Setting Up Serilog

First, you’ll need to install Serilog and the Serilog ASP.NET Core integration package using NuGet:

Install-Package Serilog
Install-Package Serilog.AspNetCore

Next, configure Serilog in your Startup.cs class. This typically involves setting up a logger and adding it to the service collection.

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using SerLog = Serilog.ILogger;
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddLogging(builder =>
        {
            builder.AddSerilog(dispose: true);
        });
        
        // Other configurations...
    }
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // Other configurations...
    }
}

Logging with Serilog and SQL Server

The next step is to configure Serilog to log events to a SQL Server database. For this, you’ll need the Serilog Serilog.Sinks.SqlClient NuGet package.

Install-Package SerLog.Sinks.SqlClient

Then, in your application configuration, set up a sink that writes logs to SQL Server:

using Microsoft.Extensions.Logging;
using Serilog;
using Serlog = Serilog.ILogger;
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        var logger = new LoggerConfiguration()
            .WriteTo.SqlClient(
                connectionString: "Server=myserver;Database=mydb;",
                tableName: "mylogs",
                columnOptions:
                    new ColumnOptions("getdate()") { ConvertTimeToUtc = true })
            .CreateLogger();
        services.AddLogging(logging =>
        {
            logging.AddSerilog(logger, true);
        });
        
        // Other configurations...
    }
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // Other configurations...
    }
}

Conclusion

Using Serilog with ASP.NET Core to log events to a SQL Server database is straightforward and offers the flexibility you need for your application. By following this guide, you can enhance the logging capabilities of your ASP.NET Core project with minimal effort.

Poespas Blog