prometheus4cats-java/prometheus4cats.javasimpleclient/JavaMetricRegistry

JavaMetricRegistry

prometheus4cats.javasimpleclient.JavaMetricRegistry

See theJavaMetricRegistry companion object

class JavaMetricRegistry[F[_]] extends DoubleMetricRegistry[F], DoubleCallbackRegistry[F]

Attributes

Companion: object
Graph
Supertypes: trait DoubleCallbackRegistry[F]

trait CallbackRegistry[F]

trait DoubleMetricRegistry[F]

trait MetricRegistry[F]

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

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
Definition Classes: MetricRegistry

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
Definition Classes: MetricRegistry

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: MetricRegistry

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
Definition Classes: MetricRegistry

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
Definition Classes: MetricRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of scala.Double and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: CallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of scala.Double and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: CallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of Histogram.Value parameterised with scala.Double and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: CallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of Summary.Value parameterised with scala.Double and label value tuples
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: Summary.Name metric name
prefix: optional Metric.Prefix to be prepended to the metric name

Attributes

Returns: a Summary wrapped in whatever side effect that was performed in registering it
Definition Classes: CallbackRegistry

Attributes

Definition Classes: CallbackRegistry

Inherited methods

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: DoubleMetricRegistry -> MetricRegistry
Inherited from:: DoubleMetricRegistry

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: DoubleMetricRegistry -> MetricRegistry
Inherited from:: DoubleMetricRegistry

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: DoubleMetricRegistry -> MetricRegistry
Inherited from:: DoubleMetricRegistry

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: DoubleMetricRegistry -> MetricRegistry
Inherited from:: DoubleMetricRegistry

Given a natural transformation from F to G and from G to F, transforms this CallbackRegistry from effect F to effect G

Attributes

Inherited from:: CallbackRegistry

Attributes

Inherited from:: MetricRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of scala.Long and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: DoubleCallbackRegistry -> CallbackRegistry
Inherited from:: DoubleCallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of scala.Long and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: DoubleCallbackRegistry -> CallbackRegistry
Inherited from:: DoubleCallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of Histogram.Value parameterised with scala.Long and label value tuples
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: An empty side effect to indicate that the callback has been registered
Definition Classes: DoubleCallbackRegistry -> CallbackRegistry
Inherited from:: DoubleCallbackRegistry

Value parameters

callback: Some effectful operation that returns a cats.data.NonEmptyList of Summary.Value parameterised with scala.Long and label value tuples
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: Summary.Name metric name
prefix: optional Metric.Prefix to be prepended to the metric name

Attributes

Returns: a Summary wrapped in whatever side effect that was performed in registering it
Definition Classes: DoubleCallbackRegistry -> CallbackRegistry
Inherited from:: DoubleCallbackRegistry

In this article

Generated with