Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class GaugeWithCallback

Object

Metric

MetricWithFixedMetadata

GaugeWithCallback

All Implemented Interfaces:

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

Method Summary

Modifier and Type	Method	Description
static GaugeWithCallback.Builder	builder()
static GaugeWithCallback.Builder	builder(PrometheusProperties properties)
GaugeSnapshot	collect()

Methods inherited from class MetricWithFixedMetadata

getPrometheusName

Methods inherited from class Object

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

Methods inherited from interface Collector

collect, collect, collect

Method Details

collect

public GaugeSnapshot collect()

Specified by:

collect in interface Collector

Specified by:

collect in class Metric

builder

public static GaugeWithCallback.Builder builder()

builder

public static GaugeWithCallback.Builder builder(PrometheusProperties properties)