http (feature): Support adding extra logParamters to individual HTTP …

…requests
wvlet · Mar 5, 2025 · 4b320e4 · 4b320e4
1 parent 10a4a26
commit 4b320e4
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/...ame-http/.jvm/src/test/scala/wvlet/airframe/http/client/HttpClientLoggingFilterTest.scala b/...ame-http/.jvm/src/test/scala/wvlet/airframe/http/client/HttpClientLoggingFilterTest.scala
@@ -66,6 +66,15 @@ class HttpClientLoggingFilterTest extends AirSpec {
     test("switch dest") {
       client.send(Http.GET("/").withDest(ServerAddress("localhost:8081")))
     }
+
+    test("with logParameters") {
+      client.send(
+        Http.GET("/"),
+        context = HttpClientContext(
+          logParameters = Map("k1" -> "v1")
+        )
+      )
+    }
   }
 
 }
diff --git a/airframe-http/src/main/scala/wvlet/airframe/http/client/HttpClientContext.scala b/airframe-http/src/main/scala/wvlet/airframe/http/client/HttpClientContext.scala
@@ -20,9 +20,11 @@ import wvlet.airframe.http.RPCMethod
   * @param rpcMethod
   */
 case class HttpClientContext(
-    clientName: String,
+    clientName: String = "default",
     rpcMethod: Option[RPCMethod] = None,
-    rpcInput: Option[Any] = None
+    rpcInput: Option[Any] = None,
+    // Extra parameters used for logging
+    logParameters: Map[String, Any] = Map.empty
 )
 
 object HttpClientContext {

diff --git a/airframe-http/src/main/scala/wvlet/airframe/http/internal/HttpLogs.scala b/airframe-http/src/main/scala/wvlet/airframe/http/internal/HttpLogs.scala
@@ -50,8 +50,9 @@ object HttpLogs extends LogSupport {
       m ++= requestHeaderLogs(request, httpLogger.excludeHeaders)
 
       // Log RPC context in the client side
-      clientContext.foreach {
-        _.rpcMethod.map { rpc => m ++= rpcMethodLogs(rpc) }
+      clientContext.foreach { ctx =>
+        ctx.rpcMethod.map { rpc => m ++= rpcMethodLogs(rpc) }
+        m ++= ctx.logParameters
       }
       // Log RPC context in the server side
       rpcContext.flatMap(_.rpcCallContext).foreach { rcc =>