feature(#6): this commit implements correlation middleware to improve traceability in observability and tracing tools

Author: https-richardy

Boundaries/Comanda.Orchestrator/Source/Comanda.Orchestrator.WebApi/Middlewares/CorrelationMiddleware.cs

@@ -0,0 +1,29 @@
+namespace Comanda.Orchestrator.WebApi.Middlewares;
+
+public sealed class CorrelationMiddleware(RequestDelegate next)
+{
+    public async Task InvokeAsync(HttpContext context)
+    {
+        var correlationId = context.Request.Headers[Headers.Correlation].FirstOrDefault();
+
+        if (string.IsNullOrWhiteSpace(correlationId))
+            correlationId = context.TraceIdentifier;
+
+        context.Items[Headers.Correlation] = correlationId;
+        context.Response.Headers[Headers.Correlation] = correlationId;
+
+        /* enriches the logging scope with the current correlation identifier, ensuring all logs within this request pipeline share the same identifier */
+        /* more details: https://microsoft.github.io/code-with-engineering-playbook/observability/correlation-id/ */
+
+        using (LogContext.PushProperty(Headers.Correlation, correlationId))
+        using (SentrySdk.PushScope())
+        {
+            SentrySdk.ConfigureScope(scope =>
+            {
+                scope.SetTag("correlation_id", correlationId);
+            });
+
+            await next(context);
+        }
+    }
+}

Boundaries/Comanda.Orchestrator/Source/Comanda.Orchestrator.WebApi/Middlewares/CorrelationMiddlewareExtension.cs

@@ -0,0 +1,10 @@
+namespace Comanda.Orchestrator.WebApi.Middlewares;
+
+[ExcludeFromCodeCoverage(Justification = "contains only dependency injection")]
+public static class CorrelationMiddlewareExtension
+{
+    public static IApplicationBuilder UseCorrelationMiddleware(this IApplicationBuilder app)
+    {
+        return app.UseMiddleware<CorrelationMiddleware>();
+    }
+}