object Prometheus
MetricsOps algebra capable of recording Prometheus metrics
For example, the following code would wrap a org.http4s.HttpRoutes with a org.http4s.server.middleware.Metrics that records metrics to a given metric registry.
import org.http4s.client.middleware.Metrics import org.http4s.client.prometheus.Prometheus val meteredRoutes = Metrics[IO](Prometheus(registry, "server"))(testRoutes)
Analogously, the following code would wrap a org.http4s.client.Client with a org.http4s.client.middleware.Metrics that records metrics to a given metric registry, classifying the metrics by HTTP method.
import org.http4s.client.middleware.Metrics import org.http4s.client.prometheus.Prometheus val classifierFunc = (r: Request[IO]) => Some(r.method.toString.toLowerCase) val meteredClient = Metrics(Prometheus(registry, "client"), classifierFunc)(client)
Registers the following metrics:
{prefix}_response_duration_seconds{labels=classifier,method,phase} - Histogram
{prefix}_active_request_count{labels=classifier} - Gauge
{prefix}_request_count{labels=classifier,method,status} - Counter
{prefix}_abnormal_terminations{labels=classifier,termination_type} - Histogram
Labels --
method: Enumeration values: get, put, post, head, move, options, trace, connect, delete, other
phase: Enumeration values: headers, body
code: Enumeration values: 1xx, 2xx, 3xx, 4xx, 5xx
termination_type: Enumeration values: abnormal, error, timeout
- Source
- Prometheus.scala
- Alphabetic
- By Inheritance
- Prometheus
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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[_]](registry: CollectorRegistry, prefix: String)(implicit F: Sync[F]): MetricsOps[F]
Creates a MetricsOps that supports Prometheus metrics * * @param registry a metrics collector registry * @param prefix a prefix that will be added to all metrics
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- 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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )