如何记录 Akka HTTP 客户端请求

Question

我需要记录 akka http 客户端请求及其响应。虽然似乎有用于记录这些请求的 API 提示，但没有关于应该如何完成的明确文档。我的方法是创建一个记录的请求，它透明地包装Http().singleRequest(req)，如下所示：

def loggedRequest(req: HttpRequest)
                  (implicit system: ActorSystem, ctx: ExecutionContext, m: Materializer): Future[HttpResponse] = {

  Http().singleRequest(req).map { resp ⇒
    Unmarshal(resp.entity).to[String].foreach{s ⇒
      system.log.info(req.toString)
      system.log.info(resp.toString + "\n" + s)
    }
    resp
  }
}

不幸的是，我必须通过 unmarshal 或简单地请求 resp.entity.dataBytes 来获取未来，以便恢复响应的主体。我得到了日志记录，但承诺已经完成，我不能再将实体解组为实际数据。一个可行的解决方案将记录请求和响应并通过此测试用例，而不会抛出“承诺已完成”的IllegalStateException：

describe("Logged rest requests") {

  it("deliver typed responses") {
    val foo = Rest.loggedRequest(Get(s"http://127.0.0.1:9000/some/path"))
    val resp = foo.futureValue(patience)
    resp.status shouldBe StatusCodes.OK
    val res = Unmarshal(resp.entity).to[MyClass].futureValue
  }
}

欢迎提出想法。

Answer 1

我发现的解决方案之一是使用：

import akka.http.scaladsl.server.directives.DebuggingDirectives

val clientRouteLogged = DebuggingDirectives.logRequestResult("Client ReST", Logging.InfoLevel)(clientRoute)
Http().bindAndHandle(clientRouteLogged, interface, port)

这可以轻松记录请求并以原始（字节）格式生成。问题是这些日志完全不可读。这就是它变得复杂的地方。

这是我的示例，它对请求/响应的实体进行编码并将其写入记录器。

您可以将函数传递给：

DebuggingDirectives.logRequestResult

def logRequestResult(magnet: LoggingMagnet[HttpRequest ⇒ RouteResult ⇒ Unit])

这是使用magnet pattern编写的函数：

LoggingMagnet[HttpRequest ⇒ RouteResult ⇒ Unit]

地点：

LoggingMagnet[T](f: LoggingAdapter ⇒ T)

感谢我们可以访问记录请求和结果所需的所有部分。我们有 LoggingAdapter、HttpRequest 和 RouteResult

就我而言，我创建了一个内部函数。我不想再次传递所有参数。

def logRequestResult(level: LogLevel, route: Route)
                      (implicit m: Materializer, ex: ExecutionContext) = {
  def myLoggingFunction(logger: LoggingAdapter)(req: HttpRequest)(res: Any): Unit = {
    val entry = res match {
      case Complete(resp) =>
        entityAsString(resp.entity).map(data ⇒ LogEntry(s"${req.method} ${req.uri}: ${resp.status} \n entity: $data", level))
      case other =>
        Future.successful(LogEntry(s"$other", level))
    }
    entry.map(_.logTo(logger))
  }
  DebuggingDirectives.logRequestResult(LoggingMagnet(log => myLoggingFunction(log)))(route)
}

最重要的部分是我将 myLoggingFunction 放入 logRequestResult 的最后一行。

名为myLoggingFunction的函数，简单匹配服务器计算的结果，并基于它创建一个LogEntry。

最后一件事是允许从流中解码结果实体的方法。

def entityAsString(entity: HttpEntity)
                   (implicit m: Materializer, ex: ExecutionContext): Future[String] = {
entity.dataBytes
  .map(_.decodeString(entity.contentType().charset().value))
  .runWith(Sink.head)
}

该方法可以轻松添加到任何 akka-http 路由中。

val myLoggedRoute = logRequestResult(Logging.InfoLevel, clinetRoute)
Http().bindAndHandle(myLoggedRoute, interface, port)

Answer 2

对于另一种解决方案，此代码记录请求 IP 并将随机数与每个请求和响应相关联，以便它们可以在日志中关联。它还记录响应时间。

由于请求可能需要一段时间才能处理，并且可能会失败，所以我想立即查看请求，并查看响应是否以及何时返回。

RequestFields 只是我在请求中关心的数据。默认情况下有很多噪音。

val logRequestResponse: Directive0 =
  extractRequestContext flatMap { ctx =>
    extractClientIP flatMap { ip =>
      val id = scala.math.abs(rand.nextLong).toString
      onSuccess(RequestFields.fromIdIpAndRequest(id, ip, ctx.request)) flatMap { req =>
        logger.info("request", req.asJson)
        val i = Instant.now()
        mapRouteResultWith { result => 
          Result.fromIdStartTimeAndRouteResult(id, i, result) map { res =>
            logger.info("response", res.asJson)
            result
        }
      }
    }
  }
}

Answer 3

我的完整解决方案，灵感来自@seanmcl

trait TraceDirectives extends LazyLogging {

  private val counter: AtomicLong = new AtomicLong(0)

  def log: Directive0 = count flatMap { requestId =>
    mapInnerRoute(addLoggingToRoute(requestId, _))
  }

  private def count: Directive1[Long] = Directive { innerRouteSupplier =>
    ctx =>
      innerRouteSupplier(Tuple1(counter.incrementAndGet()))(ctx)
  }

  private def addLoggingToRoute(requestId: Long, innerRoute: Route): Route = {
    ctx => {
      val requestStopwatch = Stopwatch.createStarted()
      extractClientIP { ip =>
        logger.info("Http request, id: {}, uri: {}, forwarded ip: {}", requestId, ctx.request.uri, ip)
        mapResponse(httpResponse => {
          logger.info("Http response, id: {}, code: {}, time: {}", requestId, httpResponse.status.intValue(), requestStopwatch.toString)
          httpResponse
        })(innerRoute)
      }(ctx)
    }
  }
}

object TraceDirectives extends TraceDirectives