Update comments

hummingbird-project · Dec 14, 2023 · 6968f7e · 6968f7e
1 parent 620fd44
commit 6968f7e
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/Sources/Hummingbird/Middleware/TracingMiddleware.swift b/Sources/Hummingbird/Middleware/TracingMiddleware.swift
@@ -31,8 +31,9 @@ public struct HBTracingMiddleware<Context: HBBaseRequestContext>: HBMiddleware {
     ///
     /// - Parameters
     ///     - recordingHeaders: A list of HTTP header names to be recorded as span attributes. By default, no headers
-    ///     - parameters: A list of static parameters added to every span. These could be
-    /// are being recorded.
+    ///         are being recorded.
+    ///     - parameters: A list of static parameters added to every span. These could be the "net.host.name", 
+    ///         "net.host.port" or "http.scheme"
     public init(recordingHeaders headerNamesToRecord: some Collection<HTTPField.Name> = [], attributes: SpanAttributes? = nil) {
         self.headerNamesToRecord = Set(headerNamesToRecord.map(RecordingHeader.init))
         self.attributes = attributes