Integrate Serilog for Enhanced Logging

Added Serilog packages to `PdfSmith.csproj` for structured logging. Integrated Serilog in `Program.cs` to log HTTP requests and configured it using `appsettings.Development.json` and `appsettings.json`. Introduced `HttpContextLogEventEnricher` to enrich logs with user information. Updated logging to write to console and SQL Server, providing detailed control over log output and filtering.

Closes #6

Author: marcominerva

src/PdfSmith/Logging/HttpContextLogEventEnricher.cs

@@ -0,0 +1,19 @@
+using Serilog.Core;
+using Serilog.Events;
+
+namespace PdfSmith.Logging;
+
+public class HttpContextEnricher(IHttpContextAccessor httpContextAccessor) : ILogEventEnricher
+{
+    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+    {
+        var httpContext = httpContextAccessor.HttpContext;
+
+        if (httpContext is null)
+        {
+            return;
+        }
+
+        logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("UserName", httpContext.User?.Identity?.Name));
+    }
+}

src/PdfSmith/PdfSmith.csproj

@@ -18,6 +18,9 @@
         <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="9.0.9" />
         <PackageReference Include="MinimalHelpers.FluentValidation" Version="1.1.4" />
         <PackageReference Include="OperationResultTools.AspNetCore.Http" Version="1.0.30" />
+        <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
+        <PackageReference Include="Serilog.Expressions" Version="5.0.0" />
+        <PackageReference Include="Serilog.Sinks.MSSqlServer" Version="8.2.2" />
         <PackageReference Include="SimpleAuthenticationTools" Version="3.0.15" />
         <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
         <PackageReference Include="TinyHelpers.AspNetCore" Version="4.1.6" />

src/PdfSmith/Program.cs

@@ -25,16 +25,25 @@
 using PdfSmith.BusinessLayer.Validations;
 using PdfSmith.DataAccessLayer;
 using PdfSmith.HealthChecks;
+using PdfSmith.Logging;
 using PdfSmith.Shared.Models;
+using Serilog;
+using Serilog.Core;
 using SimpleAuthentication;
 using SimpleAuthentication.ApiKey;
 using TinyHelpers.AspNetCore.Extensions;
 using TinyHelpers.AspNetCore.OpenApi;
 
 var builder = WebApplication.CreateBuilder(args);
+builder.Host.UseSerilog((hostingContext, services, loggerConfiguration) =>
+{
+    loggerConfiguration.ReadFrom.Configuration(hostingContext.Configuration);
+    loggerConfiguration.ReadFrom.Services(services);
+});
 
 // Add services to the container.
 builder.Services.AddHttpContextAccessor();
+builder.Services.AddSingleton<ILogEventEnricher, HttpContextEnricher>();
 
 builder.Services.AddSingleton(TimeProvider.System);
 builder.Services.AddSingleton<RequestTimeProvider>();
@@ -167,6 +176,12 @@
 app.UseRequestLocalization();
 
 app.UseAuthentication();
+
+app.UseSerilogRequestLogging(options =>
+{
+    options.IncludeQueryInRequestPath = true;
+});
+
 app.UseAuthorization();
 
 app.UseRateLimiter();
@@ -252,4 +267,5 @@ static Func<HttpContext, HealthReport, Task> HealthChecksResponseWriter()
 
         context.Response.ContentType = MediaTypeNames.Application.Json;
         await context.Response.WriteAsync(result);
-    };
+    };
+

src/PdfSmith/appsettings.Development.json

@@ -1,15 +1,19 @@
 {
     "ConnectionStrings": {
-        "SqlConnection": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MinimalDB;Integrated Security=true"
+        "SqlConnection": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MinimalDB;Integrated Security=true",
+        "LogsConnection": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MinimalDB;Integrated Security=true"
     },
     "AppSettings": {
         "AdministratorUserName": "[email protected]",
         "AdministratorApiKey": "KNIkRRngxoOyo2e1egkrz4wUi3pfyaD4g0q3uZTp6jaRMtThx9"
     },
-    "Logging": {
-        "LogLevel": {
-            "Default": "Information",
-            "Microsoft.AspNetCore": "Warning"
+    "Serilog": {
+        "MinimumLevel": {
+            "Override": {
+                "Microsoft.AspNetCore": "Warning",
+                "Microsoft.EntityFrameworkCore": "Information",
+                "Microsoft.EntityFrameworkCore.Database.Command": "Information"
+            }
         }
     }
 }

src/PdfSmith/appsettings.json

@@ -1,6 +1,7 @@
 {
     "ConnectionStrings": {
-        "SqlConnection": ""
+        "SqlConnection": "",
+        "LogsConnection": ""
     },
     "Authentication": {
         "ApiKey": {
@@ -11,11 +12,72 @@
         "AdministratorUserName": null,
         "AdministratorApiKey": null
     },
-    "Logging": {
-        "LogLevel": {
+    "Serilog": {
+        "Using": [ "Serilog.Sinks.MSSqlServer", "Serilog.Expressions" ],
+        "MinimumLevel": {
             "Default": "Information",
-            "Microsoft.AspNetCore": "Warning"
-        }
+            "Override": {
+                "Microsoft": "Warning",
+                "Microsoft.AspNetCore.Identity": "Error",
+                "Microsoft.EntityFrameworkCore": "Error",
+                "Microsoft.EntityFrameworkCore.Database.Command": "Warning",
+                "System": "Warning"
+            }
+        },
+        "WriteTo": [
+            {
+                "Name": "Debug"
+            },
+            {
+                "Name": "Console",
+                "Args": {
+                    "theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
+                    "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} <{SourceContext}>{NewLine}{Exception}"
+                }
+            },
+            {
+                "Name": "MSSqlServer",
+                "Args": {
+                    "connectionString": "LogsConnection",
+                    "sinkOptionsSection": {
+                        "tableName": "Logs",
+                        "autoCreateSqlTable": true
+                    },
+                    "restrictedToMinimumLevel": "Information",
+                    "columnOptionsSection": {
+                        "addStandardColumns": [ "LogEvent", "TraceId", "SpanId" ],
+                        "removeStandardColumns": [ "MessageTemplate", "Properties" ],
+                        "additionalColumns": [
+                            {
+                                "ColumnName": "UserName",
+                                "PropertyName": "UserName",
+                                "DataType": "nvarchar",
+                                "DataLength": 255,
+                                "AllowNull": true
+                            }
+                        ],
+                        "id": { "dataType": "bigint" },
+                        "timeStamp": {
+                            "columnName": "Timestamp",
+                            "convertToUtc": true
+                        },
+                        "logEvent": {
+                            "excludeAdditionalProperties": false,
+                            "excludeStandardColumns": false
+                        }
+                    }
+                }
+            }
+        ],
+        "Filter": [
+            {
+                "Name": "ByExcluding",
+                "Args": {
+                    "expression": "RequestMethod = 'OPTIONS' OR RequestPath LIKE '/openapi/%'"
+                }
+            }
+        ],
+        "Enrich": [ "FromLogContext" ]
     },
     "AllowedHosts": "*",
     "https_ports": "443"