Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class CounterWithCallback

java.lang.Object

io.prometheus.metrics.core.metrics.Metric

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

io.prometheus.metrics.core.metrics.CounterWithCallback

All Implemented Interfaces:

io.prometheus.metrics.model.registry.Collector

@StableApi
public class CounterWithCallback
extends MetricWithFixedMetadata

Example:

 ClassLoadingMXBean classLoadingMXBean = ManagementFactory.getClassLoadingMXBean();

 CounterWithCallback.builder()
         .name("classes_loaded_total")
         .help("The total number of classes since the JVM has started execution")
         .callback(callback -> callback.call(classLoadingMXBean.getLoadedClassCount()))
         .register();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CounterWithCallback.Builder
static interface	CounterWithCallback.Callback

Field Summary

Fields inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

labelNames, metadata

Fields inherited from class io.prometheus.metrics.core.metrics.Metric

constLabels

Method Summary

Modifier and Type	Method	Description
static CounterWithCallback.Builder	builder()
static CounterWithCallback.Builder	builder(io.prometheus.metrics.config.PrometheusProperties properties)
io.prometheus.metrics.model.snapshots.CounterSnapshot	collect()
io.prometheus.metrics.model.registry.MetricType	getMetricType()	Deprecated. Use MetricWithFixedMetadata.getMetricFamilyDescriptor() instead.
protected io.prometheus.metrics.model.snapshots.Labels	makeLabels(String... labelValues)

Methods inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

getLabelNames, getMetadata, getMetricFamilyDescriptor, getPrometheusName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.prometheus.metrics.model.registry.Collector

collect, collect, collect

Method Details

collect

public io.prometheus.metrics.model.snapshots.CounterSnapshot collect()

Specified by:

collect in interface io.prometheus.metrics.model.registry.Collector

Specified by:

collect in class Metric

getMetricType

@Deprecated
public io.prometheus.metrics.model.registry.MetricType getMetricType()

Deprecated.

Use MetricWithFixedMetadata.getMetricFamilyDescriptor() instead.

builder

public static CounterWithCallback.Builder builder()

builder

public static CounterWithCallback.Builder builder(io.prometheus.metrics.config.PrometheusProperties properties)

makeLabels

protected io.prometheus.metrics.model.snapshots.Labels makeLabels(String... labelValues)