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
- Alphabetic
- By Inheritance
- Metrics
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[F[_]](ops: MetricsOps[F], emptyResponseHandler: Option[Status] = Status.NotFound.some, errorResponseHandler: (Throwable) => Option[Status] = _ => Status.InternalServerError.some, classifierF: (Request[F]) => Option[String] = (_: Request[F]) =>
None)(routes: HttpRoutes[F])(implicit F: Clock[F], C: MonadCancel[F, Throwable]): 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def effect[F[_]](ops: MetricsOps[F], emptyResponseHandler: Option[Status] = Status.NotFound.some, errorResponseHandler: (Throwable) => Option[Status] = _ => Status.InternalServerError.some, classifierF: (Request[F]) => F[Option[String]])(routes: HttpRoutes[F])(implicit F: Clock[F], C: MonadCancel[F, Throwable]): HttpRoutes[F]
A server middleware capable of recording metrics
A server middleware capable of recording metrics
Same as apply, but can classify requests effectually, e.g. performing side-effects. Failed attempt to classify the request (e.g. failing with
F.raiseError
) leads to not recording metrics for that request.- 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
- Note
Compiling the request body in
classifierF
is unsafe, unless you are using some caching middleware.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()