DoubleMetricRegistry

prometheus4cats.util.DoubleMetricRegistry
trait DoubleMetricRegistry[F[_]] extends MetricRegistry[F]

Attributes

Source
DoubleMetricRegistry.scala
Graph
Supertypes
trait MetricRegistry[F]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def createAndRegisterLongCounter[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name])(f: A => IndexedSeq[String]): Resource[F, Counter[F, Long, A]]

Create and register a labelled counter that records scala.Long values against a metrics registry

Create and register a labelled counter that records scala.Long values against a metrics registry

Value parameters

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Counter.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Counter wrapped in whatever side effect that was performed in registering it

Definition Classes
Source
DoubleMetricRegistry.scala
override def createAndRegisterLongGauge[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name])(f: A => IndexedSeq[String]): Resource[F, Gauge[F, Long, A]]

Create and register a labelled gauge that records scala.Long values against a metrics registry

Create and register a labelled gauge that records scala.Long values against a metrics registry

Value parameters

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Gauge.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Gauge wrapped in whatever side effect that was performed in registering it

Definition Classes
Source
DoubleMetricRegistry.scala
override def createAndRegisterLongHistogram[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Long])(f: A => IndexedSeq[String]): Resource[F, Histogram[F, Long, A]]

Create and register a labelled histogram against a metrics registry

Create and register a labelled histogram against a metrics registry

Value parameters

buckets

a cats.data.NonEmptySeq of scala.Doubles representing bucket values for the histogram

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Histogram.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Histogram wrapped in whatever side effect that was performed in registering it

Definition Classes
Source
DoubleMetricRegistry.scala
override def createAndRegisterLongSummary[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], quantiles: Seq[QuantileDefinition], maxAge: FiniteDuration, ageBuckets: AgeBuckets)(f: A => IndexedSeq[String]): Resource[F, Summary[F, Long, A]]

Create and register a summary that records scala.Long values against a metrics registry

Create and register a summary that records scala.Long values against a metrics registry

Value parameters

ageBuckets

how many intervals there should be in a given time window defined by maxAge. For example, if a time window of 10 minutes and 5 age buckets, i.e. the time window is 10 minutes wide, and we slide it forward every 2 minutes.

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

maxAge

a scala.concurrent.duration.FiniteDuration indicating a window over which the summary should be calculate. Typically, you don't want to have a Summary representing the entire runtime of the application, but you want to look at a reasonable time interval. Summary metrics should implement a configurable sliding time window.

name

Summary.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

quantiles

a scala.Seq of Summary.QuantileDefinitions representing bucket values for the summary. Quantiles are expensive to calculate, so this may be empty.

Attributes

Returns

a Summary wrapped in whatever side effect that was performed in registering it

Definition Classes
Source
DoubleMetricRegistry.scala

Inherited methods

def createAndRegisterDoubleCounter[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name])(f: A => IndexedSeq[String]): Resource[F, Counter[F, Double, A]]

Create and register a labelled counter that records scala.Double values against a metrics registry

Create and register a labelled counter that records scala.Double values against a metrics registry

Value parameters

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Counter.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Counter wrapped in whatever side effect that was performed in registering it

Inherited from:
MetricRegistry
Source
MetricRegistry.scala
def createAndRegisterDoubleGauge[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name])(f: A => IndexedSeq[String]): Resource[F, Gauge[F, Double, A]]

Create and register a labelled gauge that records scala.Double values against a metrics registry

Create and register a labelled gauge that records scala.Double values against a metrics registry

Value parameters

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Gauge.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Gauge wrapped in whatever side effect that was performed in registering it

Inherited from:
MetricRegistry
Source
MetricRegistry.scala
def createAndRegisterDoubleHistogram[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], buckets: NonEmptySeq[Double])(f: A => IndexedSeq[String]): Resource[F, Histogram[F, Double, A]]

Create and register a labelled histogram against a metrics registry

Create and register a labelled histogram against a metrics registry

Value parameters

buckets

a cats.data.NonEmptySeq of scala.Doubles representing bucket values for the histogram

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

name

Histogram.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Histogram wrapped in whatever side effect that was performed in registering it

Inherited from:
MetricRegistry
Source
MetricRegistry.scala
def createAndRegisterDoubleSummary[A](prefix: Option[Prefix], name: Name, help: Help, commonLabels: CommonLabels, labelNames: IndexedSeq[Name], quantiles: Seq[QuantileDefinition], maxAge: FiniteDuration, ageBuckets: AgeBuckets)(f: A => IndexedSeq[String]): Resource[F, Summary[F, Double, A]]

Create and register a summary that records scala.Double values against a metrics registry

Create and register a summary that records scala.Double values against a metrics registry

Value parameters

ageBuckets

how many intervals there should be in a given time window defined by maxAge. For example, if a time window of 10 minutes and 5 age buckets, i.e. the time window is 10 minutes wide, and we slide it forward every 2 minutes.

commonLabels

Metric.CommonLabels map of common labels to be added to the metric

f

a function from A to an scala.IndexedSeq of java.lang.String that provides label values, which must be paired with their corresponding name in the scala.IndexedSeq of Label.Names

help

Metric.Help string to describe the metric

labelNames

an scala.IndexedSeq of Label.Names to annotate the metric with

maxAge

a scala.concurrent.duration.FiniteDuration indicating a window over which the summary should be calculate. Typically, you don't want to have a Summary representing the entire runtime of the application, but you want to look at a reasonable time interval. Summary metrics should implement a configurable sliding time window.

name

Summary.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

quantiles

a scala.Seq of Summary.QuantileDefinitions representing bucket values for the summary. Quantiles are expensive to calculate, so this may be empty.

Attributes

Returns

a Summary wrapped in whatever side effect that was performed in registering it

Inherited from:
MetricRegistry
Source
MetricRegistry.scala
def createAndRegisterInfo(prefix: Option[Prefix], name: Name, help: Help): Resource[F, Info[F, Map[Name, String]]]

Create and register an info metric against a metrics registry

Create and register an info metric against a metrics registry

Value parameters

help

Metric.Help string to describe the metric

name

Histogram.Name metric name

prefix

optional Metric.Prefix to be prepended to the metric name

Attributes

Returns

a Info wrapped in whatever side effect that was performed in registering it

Inherited from:
MetricRegistry
Source
MetricRegistry.scala
def mapK[G[_]](fk: FunctionK[F, G])(implicit F: MonadCancel[F, _], G: MonadCancel[G, _]): MetricRegistry[G]

Attributes

Inherited from:
MetricRegistry
Source
MetricRegistry.scala