Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class GaugeWithCallback

java.lang.Object

io.prometheus.metrics.core.metrics.Metric

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

io.prometheus.metrics.core.metrics.GaugeWithCallback

All Implemented Interfaces:

io.prometheus.metrics.model.registry.Collector

public class GaugeWithCallback
extends MetricWithFixedMetadata

Example:

 MemoryMXBean memoryBean = ManagementFactory.getMemoryMXBean();

 GaugeWithCallback.builder()
     .name("jvm_memory_bytes_used")
     .help("Used bytes of a given JVM memory area.")
     .unit(Unit.BYTES)
     .labelNames("area")
     .callback(callback -> {
         callback.call(memoryBean.getHeapMemoryUsage().getUsed(), "heap");
         callback.call(memoryBean.getNonHeapMemoryUsage().getUsed(), "nonheap");
     })
     .register();
 

Nested Class Summary

Nested Classes

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

Field Summary

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

labelNames

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

constLabels

Method Summary

Modifier and Type	Method	Description
static GaugeWithCallback.Builder	builder()
static GaugeWithCallback.Builder	builder(io.prometheus.metrics.config.PrometheusProperties properties)
io.prometheus.metrics.model.snapshots.GaugeSnapshot	collect()
protected io.prometheus.metrics.model.snapshots.Labels	makeLabels(String... labelValues)

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

getMetadata, 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.GaugeSnapshot collect()

Specified by:

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

Specified by:

collect in class Metric

builder

public static GaugeWithCallback.Builder builder()

builder

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

makeLabels

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