adding a replacement for the default route logging middleware from Vapor that adds in the cf-ray id, if any, from cloudflare

Author: heckj

Sources/App/Core/CFRayRouteLoggingMiddleware.swift

@@ -0,0 +1,17 @@
+import Vapor
+
+// Replica of the Vapor RouteLoggingMiddleware that's tweaked to explicitly expose the cf-ray header in the logger metadata for the request.
+public final class CFRayRouteLoggingMiddleware: Middleware {
+    public let logLevel: Logger.Level
+    
+    public init(logLevel: Logger.Level = .info) {
+        self.logLevel = logLevel
+    }
+    
+    public func respond(to request: Request, chainingTo next: Responder) -> EventLoopFuture<Response> {
+        let cfray = request.headers.first(name: "cf-ray") ?? "--nil--"
+        request.logger[metadataKey: "cf-ray"] = .string(cfray)
+        request.logger.log(level: self.logLevel, "\(request.method) \(request.url.path.removingPercentEncoding ?? request.url.path)")
+        return next.respond(to: request)
+    }
+}

Sources/App/configure.swift

@@ -36,6 +36,15 @@ public func configure(_ app: Application) async throws -> String {
     // app.http.server.configuration.responseCompression = .enabled
     // app.http.server.configuration.requestDecompression = .enabled
 
+    // This stanza replaces the default middleware from Vapor, specifically replacing the
+    // default route logging middleware with the tweaked up version that reports on the cf-ray
+    // header (if any) from CloudFlare.
+    app.middleware = Middlewares()
+    app.middleware.use(Vapor.ErrorMiddleware.default(environment: app.environment))
+    app.middleware.use(CFRayRouteLoggingMiddleware())
+    // disable the 3 lines above to return to the default middleware setup before we add SPI-specific
+    // middleware.
+
     app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
     app.middleware.use(ErrorMiddleware())