case class PrometheusMetrics[F[_]](namespace: String = "tapir", registry: PrometheusRegistry = PrometheusRegistry.defaultRegistry, metrics: List[Metric[F, _]] = List.empty[Metric[F, _]], endpointPrefix: EndpointInput[Unit] = "metrics") extends Product with Serializable
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- PrometheusMetrics
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
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 addCustom(m: Metric[F, _]): PrometheusMetrics[F]
Registers a custom metric.
- def addRequestsActive(labels: MetricLabels = MetricLabels.Default): PrometheusMetrics[F]
Registers a
$namespace_request_active{path, method}gauge (assuming default labels). - def addRequestsDuration(labels: MetricLabels = MetricLabels.Default, clock: Clock = Clock.systemUTC()): PrometheusMetrics[F]
Registers a
$namespace_request_duration_seconds{path, method, status, phase}histogram (assuming default labels). - def addRequestsTotal(labels: MetricLabels = MetricLabels.Default): PrometheusMetrics[F]
Registers a
$namespace_request_total{path, method, status}counter (assuming default labels). - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val endpointPrefix: EndpointInput[Unit]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metrics: List[Metric[F, _]]
- lazy val metricsEndpoint: ServerEndpoint[Any, F]
An endpoint exposing the current metric values.
- def metricsInterceptor(ignoreEndpoints: Seq[AnyEndpoint] = Seq.empty): MetricsRequestInterceptor[F]
The interceptor which can be added to a server's options, to enable metrics collection.
- val namespace: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val registry: PrometheusRegistry
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)