Update logging attributes (#78)

* Update logging attributes * Move logger error into metadata * Received reserved opcode metadata change
hummingbird-project · Sep 11, 2024 · 3b09485 · 3b09485
1 parent 1505910
commit 3b09485
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/Sources/HummingbirdWSCore/WebSocketInboundStream.swift b/Sources/HummingbirdWSCore/WebSocketInboundStream.swift
@@ -78,7 +78,7 @@ public final class WebSocketInboundStream: AsyncSequence, Sendable {
                         return .init(from: frame)
                     default:
                         // if we receive a reserved opcode we should fail the connection
-                        self.handler.logger.trace("Received reserved opcode", metadata: ["opcode": .stringConvertible(frame.opcode)])
+                        self.handler.logger.trace("Received reserved opcode", metadata: ["hb.ws.opcode": .stringConvertible(frame.opcode)])
                         throw WebSocketHandler.InternalError.close(.protocolError)
                     }
                 } catch {

diff --git a/Sources/HummingbirdWebSocket/WebSocketChannel.swift b/Sources/HummingbirdWebSocket/WebSocketChannel.swift
@@ -88,7 +88,7 @@ public struct HTTP1WebSocketUpgradeChannel: ServerChildChannel, HTTPChannelHandl
                                     handler: handler
                                 )
                             } catch {
-                                logger.debug("WebSocket handler error", metadata: ["error": "\(error)"])
+                                logger.debug("WebSocket handler error", metadata: ["error.type": "\(error)"])
                             }
                         })
                     }
@@ -137,7 +137,7 @@ public struct HTTP1WebSocketUpgradeChannel: ServerChildChannel, HTTPChannelHandl
                                     handler: handler
                                 )
                             } catch {
-                                logger.debug("WebSocket handler error", metadata: ["error": "\(error)"])
+                                logger.debug("WebSocket handler error", metadata: ["error.type": "\(error)"])
                             }
                         })
                     }
@@ -218,7 +218,7 @@ public struct HTTP1WebSocketUpgradeChannel: ServerChildChannel, HTTPChannelHandl
                 await handler(asyncChannel, logger)
             }
         } catch {
-            logger.error("Error handling upgrade result: \(error)")
+            logger.error("Error handling upgrade result", metadata: ["error.type": .string("\(error)")])
         }
     }
 
@@ -265,7 +265,7 @@ public struct HTTP1WebSocketUpgradeChannel: ServerChildChannel, HTTPChannelHandl
         if clientHeaders.count > 0 {
             logger.trace(
                 "Extensions requested",
-                metadata: ["hb_extensions": .string(clientHeaders.map(\.name).joined(separator: ","))]
+                metadata: ["hb.ws.extensions": .string(clientHeaders.map(\.name).joined(separator: ","))]
             )
         }
         let extensionResponseHeaders = extensionBuilders.compactMap { $0.serverResponseHeader(to: clientHeaders) }
@@ -276,7 +276,7 @@ public struct HTTP1WebSocketUpgradeChannel: ServerChildChannel, HTTPChannelHandl
         if extensions.count > 0 {
             logger.debug(
                 "Enabled extensions",
-                metadata: ["hb_extensions": .string(extensions.map(\.name).joined(separator: ","))]
+                metadata: ["hb.ws.extensions": .string(extensions.map(\.name).joined(separator: ","))]
             )
         }
         return (responseHeaders, extensions)

diff --git a/Sources/HummingbirdWebSocket/WebSocketRouter.swift b/Sources/HummingbirdWebSocket/WebSocketRouter.swift
@@ -180,7 +180,7 @@ extension HTTP1WebSocketUpgradeChannel {
                                     handler: webSocketHandler.handler
                                 )
                             } catch {
-                                logger.debug("WebSocket handler error", metadata: ["error": "\(error)"])
+                                logger.debug("WebSocket handler error", metadata: ["error.type": "\(error)"])
                             }
                         }
                     } else {