prometheus4cats-docs
2.0.0
API
Generated with
prometheus4cats-docs/prometheus4cats/prometheus4cats.javasimpleclient/JavaMetricRegistry

JavaMetricRegistry

prometheus4cats.javasimpleclient.JavaMetricRegistry$
See theJavaMetricRegistry companion class
object JavaMetricRegistry

Attributes

Companion
class
Source
JavaMetricRegistry.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

sealed abstract class Builder(val promRegistry: CollectorRegistry, val callbackTimeout: FiniteDuration, val callbackCollectionTimeout: FiniteDuration)

Attributes

Companion
object
Source
JavaMetricRegistry.scala
Supertypes
class Object
trait Matchable
class Any
object Builder

Attributes

Companion
class
Source
JavaMetricRegistry.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Builder.type

Value members

Deprecated methods

def default[F[_] : Logger](callbackTimeout: FiniteDuration, callbackCollectionTimeout: FiniteDuration): Resource[F, JavaMetricRegistry[F]]

Create a metric registry using the default io.prometheus.client.CollectorRegistry

Create a metric registry using the default io.prometheus.client.CollectorRegistry

Note that this registry implementation introduces a runtime constraint that requires each metric must have a unique name, even if the label names are different. See this issue for more details https://github.com/prometheus/client_java/issues/696.

Value parameters

callbackCollectionTimeout

how long the combined set of callbacks for a metric or metric collection should take to time out. This is for all callbacks for a metric or all callbacks returning a metric collection.

callbackTimeout

How long all callbacks for a certain metric name should be allowed to take before timing out. This is per metric name.

Attributes

Deprecated
true
Source
JavaMetricRegistry.scala
def fromSimpleClientRegistry[F[_] : Logger](promRegistry: CollectorRegistry, callbackTimeout: FiniteDuration, callbackCollectionTimeout: FiniteDuration): Resource[F, JavaMetricRegistry[F]]

Create a metric registry using the given io.prometheus.client.CollectorRegistry

Create a metric registry using the given io.prometheus.client.CollectorRegistry

Note that this registry implementation introduces a runtime constraint that requires each metric must have a unique name, even if the label names are different. See this issue for more details https://github.com/prometheus/client_java/issues/696.

Value parameters

callbackCollectionTimeout

how long the combined set of callbacks for a metric or metric collection should take to time out. This is for all callbacks for a metric or all callbacks returning a metric collection.

callbackTimeout

How long all callbacks for a certain metric name should be allowed to take before timing out. This is per metric name.

promRegistry

the io.prometheus.client.CollectorRegistry to use

Attributes

Deprecated
true
Source
JavaMetricRegistry.scala
Generated with