Add Serilog and OpenTelemetry (#15)

Author: denbell5

docker-compose.override.yml

@@ -4,6 +4,8 @@ services:
       - ASPNETCORE_ENVIRONMENT=Development
       - ASPNETCORE_HTTP_PORTS=8080
       - ASPNETCORE_HTTPS_PORTS=8081
+      - OTEL_EXPORTER_OTLP_ENDPOINT=http://kernelmemory.ecommerce.sample.seq:5341/ingest/otlp/v1/traces
+      - OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
     ports:
       - "8080"
       - "8081"

docker-compose.yml

@@ -42,6 +42,18 @@ services:
     volumes:
       - qdrant-data:/var/lib/qdrant/storage
 
+  
+  kernelmemory.ecommerce.sample.seq:
+    image: datalust/seq
+    ports: 
+      - 5341:80
+    environment:
+      - ACCEPT_EULA=Y
+      - SEQ_FIRSTRUN_ADMINPASSWORD=password
+    volumes:
+      - seq-data:/data
+
 volumes:
   db-data:
-  qdrant-data:
+  qdrant-data:
+  seq-data:

src/KernelMemory.Ecommerce.Sample.Api/Infrastructure/Logging/OpenTelemetryRegistrationExtensions.cs

@@ -0,0 +1,46 @@
+using System.Diagnostics;
+using Npgsql;
+using OpenTelemetry.Logs;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
+
+namespace KernelMemory.Ecommerce.Sample.Api.Infrastructure.Logging;
+
+public static class OpenTelemetryRegistrationExtensions
+{
+    public static WebApplicationBuilder AddOpenTelemetry(
+        this WebApplicationBuilder builder)
+    {
+        builder.Services
+            .AddOpenTelemetry()
+            .ConfigureResource(resource => resource.AddService("kernelmemory.ecommerce.sample.api"))
+            .WithTracing(tracing =>
+            {
+                tracing
+                    .AddHttpClientInstrumentation(options =>
+                    {
+                        options.EnrichWithHttpRequestMessage = (activity, request) =>
+                        {
+                            if (request.RequestUri != null)
+                            {
+                                activity.DisplayName = $"{request.Method.Method} {request.RequestUri.AbsoluteUri}";
+                            }
+                        };
+
+                        options.EnrichWithHttpResponseMessage = (activity, response) =>
+                        {
+                            activity.DisplayName = $"{activity.DisplayName} {(int)response.StatusCode}";
+                        };
+                    })
+                    .AddAspNetCoreInstrumentation()
+                    .AddNpgsql();
+
+                // Exporter is configured in docker-compose via
+                // OTEL_EXPORTER_OTLP_ENDPOINT variable.
+                tracing.AddOtlpExporter();
+            });
+
+        return builder;
+    }
+}

src/KernelMemory.Ecommerce.Sample.Api/KernelMemory.Ecommerce.Sample.Api.csproj

@@ -15,6 +15,13 @@
     <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
     <PackageReference Include="Microsoft.KernelMemory.Service.AspNetCore" Version="0.95.241216.2" />
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.21.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.10.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.10.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.10.1" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.10.0" />
+    <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
+    <PackageReference Include="Serilog.Sinks.Seq" Version="9.0.0" />
+    <PackageReference Include="Npgsql.OpenTelemetry" Version="9.0.2" />
     <PackageReference Include="MediatR" Version="12.4.1" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
   </ItemGroup>

src/KernelMemory.Ecommerce.Sample.Api/Program.cs

@@ -1,7 +1,9 @@
 using KernelMemory.Ecommerce.Sample.Api.Application.Configuration;
 using KernelMemory.Ecommerce.Sample.Api.Infrastructure;
 using KernelMemory.Ecommerce.Sample.Api.Presentation;
+using KernelMemory.Ecommerce.Sample.Api.Infrastructure.Logging;
 using Microsoft.KernelMemory;
+using Serilog;
 
 namespace KernelMemory.Ecommerce.Sample.Api;
 
@@ -11,11 +13,16 @@ private static async Task Main(string[] args)
     {
         var builder = WebApplication.CreateBuilder(args);
 
+        builder.Host.UseSerilog((context, loggerConfig) => 
+            loggerConfig.ReadFrom.Configuration(context.Configuration));
+
         builder.Services.AddEndpointsApiExplorer();
         builder.Services.AddSwaggerGen();
 
         builder.Services.AddApplicationServices();
 
+        builder.AddOpenTelemetry();
+
         var app = BuildAsynchronousKernelMemoryApp(builder);
 
         app.UseDefaultFiles();
@@ -29,6 +36,8 @@ private static async Task Main(string[] args)
 
         app.UseHttpsRedirection();
 
+        app.UseSerilogRequestLogging();
+
         app.MapEndpoints();
 
         await app.RunAsync();

src/KernelMemory.Ecommerce.Sample.Api/appsettings.json

@@ -1,10 +1,4 @@
 {
-  "Logging": {
-    "LogLevel": {
-      "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
-  },
   "ProductSearch": {
     "SearchResultsLimit": 5,
     "MinSearchResultsRelevance": 0.8
@@ -53,5 +47,30 @@
       }
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "Serilog": {
+    "Using": [
+      "Serilog.Sinks.Console",
+      "Serilog.Sinks.Seq"
+    ],
+    "MinimumLevel": {
+      "Default": "Information",
+      "Override": {
+        "Microsoft": "Information",
+        "Microsoft.AspNetCore": "Warning",
+        "Microsoft.KernelMemory": "Debug"
+      }
+    },
+    "WriteTo": [
+      { "Name": "Console" },
+      {
+        "Name": "Seq",
+        "Args": { "serverUrl": "http://kernelmemory.ecommerce.sample.seq:5341" }
+      }
+    ],
+    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
+    "Properties": {
+      "Application": "kernelmemory.ecommerce.sample.api"
+    }
+  }
 }