object Metrics

Server middleware to record metrics for the http4s server.

This middleware will record: - Number of active requests - Time duration to send the response headers - Time duration to send the whole response body - Time duration of errors and other abnormal terminations

This middleware can be extended to support any metrics ecosystem by implementing the org.http4s.metrics.MetricsOps type

Source
Metrics.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Metrics
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def apply[F[_]](ops: MetricsOps[F], emptyResponseHandler: Option[Status] = Status.NotFound.some, errorResponseHandler: (Throwable) ⇒ Option[Status] = ..., classifierF: (Request[F]) ⇒ Option[String] = (_: Request[F]) => None)(routes: HttpRoutes[F])(implicit F: Sync[F], clock: Clock[F]): HttpRoutes[F]

    A server middleware capable of recording metrics

    A server middleware capable of recording metrics

    ops

    a algebra describing the metrics operations

    emptyResponseHandler

    an optional http status to be registered for requests that do not match

    errorResponseHandler

    a function that maps a java.lang.Throwable to an optional http status code to register

    classifierF

    a function that allows to add a classifier that can be customized per request

    returns

    the metrics middleware