Add Serilog for structured logging and update configuration in appsettings (#108)

Author: jeffcumpsty-tpx

OpenReferralApi/OpenReferralApi.csproj

@@ -28,6 +28,8 @@
         <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
         <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.15.0" />
         <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
+        <PackageReference Include="Serilog.AspNetCore" Version="8.0.3" />
+        <PackageReference Include="Serilog.Sinks.File" Version="6.0.0" />
         <PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.2" />
         <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="8.15.0" />
     </ItemGroup>

OpenReferralApi/Program.cs

@@ -15,11 +15,16 @@
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
+using Serilog;
 
 var builder = WebApplication.CreateBuilder(args);
 
 builder.Configuration.AddEnvironmentVariables("ORUK_API_");
 
+// Configure Serilog
+builder.Host.UseSerilog((context, configuration) =>
+    configuration.ReadFrom.Configuration(context.Configuration));
+
 // Configure strongly-typed options
 builder.Services.Configure<SpecificationOptions>(
     builder.Configuration.GetSection(SpecificationOptions.SectionName));
@@ -311,6 +316,7 @@ await context.Response.WriteAsync(JsonSerializer.Serialize(new
 });
 
 app.UseRouting();
+app.UseSerilogRequestLogging();
 app.UseCors();
 app.UseHttpsRedirection();
 app.UseResponseCaching();
@@ -320,3 +326,6 @@ await context.Response.WriteAsync(JsonSerializer.Serialize(new
 app.MapControllerRoute(name: "default", pattern: "{controller}/{action=Index}/{id?}");
 
 app.Run();
+
+// Ensure logs are flushed on shutdown
+Log.CloseAndFlush();

OpenReferralApi/appsettings.Production.json

@@ -1,9 +1,22 @@
 {
-  "Logging": {
-    "LogLevel": {
+  "Serilog": {
+    "Using": ["Serilog.Sinks.Console"],
+    "MinimumLevel": {
       "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
+      "Override": {
+        "Microsoft.AspNetCore": "Warning",
+        "System.Net.Http.HttpClient": "Warning"
+      }
+    },
+    "WriteTo": [
+      {
+        "Name": "Console",
+        "Args": {
+          "outputTemplate": "[{Timestamp:yyyy-MM-dd HH:mm:ss} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
+        }
+      }
+    ],
+    "Enrich": ["FromLogContext"]
   },
   "AllowedHosts": "*",
   "Specification": {

OpenReferralApi/appsettings.Staging.json

@@ -1,9 +1,22 @@
 {
-  "Logging": {
-    "LogLevel": {
+  "Serilog": {
+    "Using": ["Serilog.Sinks.Console"],
+    "MinimumLevel": {
       "Default": "Debug",
-      "Microsoft.AspNetCore": "Information"
-    }
+      "Override": {
+        "Microsoft.AspNetCore": "Information",
+        "System.Net.Http.HttpClient": "Information"
+      }
+    },
+    "WriteTo": [
+      {
+        "Name": "Console",
+        "Args": {
+          "outputTemplate": "[{Timestamp:yyyy-MM-dd HH:mm:ss} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
+        }
+      }
+    ],
+    "Enrich": ["FromLogContext"]
   },
   "AllowedHosts": "*",
   "Specification": {

OpenReferralApi/appsettings.json

@@ -1,9 +1,22 @@
 {
-  "Logging": {
-    "LogLevel": {
+  "Serilog": {
+    "Using": ["Serilog.Sinks.Console"],
+    "MinimumLevel": {
       "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
+      "Override": {
+        "Microsoft.AspNetCore": "Warning",
+        "System.Net.Http.HttpClient": "Warning"
+      }
+    },
+    "WriteTo": [
+      {
+        "Name": "Console",
+        "Args": {
+          "outputTemplate": "[{Timestamp:yyyy-MM-dd HH:mm:ss} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
+        }
+      }
+    ],
+    "Enrich": ["FromLogContext"]
   },
   "AllowedHosts": "*",
   "Specification": {