Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class Info

java.lang.Object

io.prometheus.metrics.core.metrics.Metric

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

io.prometheus.metrics.core.metrics.Info

All Implemented Interfaces:

io.prometheus.metrics.model.registry.Collector

public class Info
extends MetricWithFixedMetadata

Info metric. Example:

 Info info = Info.builder()
         .name("java_runtime_info")
         .help("Java runtime info")
         .labelNames("env", "version", "vendor", "runtime")
         .register();

 String version = System.getProperty("java.runtime.version", "unknown");
 String vendor = System.getProperty("java.vm.vendor", "unknown");
 String runtime = System.getProperty("java.runtime.name", "unknown");

 info.addLabelValues("prod", version, vendor, runtime);
 info.addLabelValues("dev", version, vendor, runtime);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Info.Builder

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
void	addLabelValues(String... labelValues)	Create an info data point with the given label values.
static Info.Builder	builder()
static Info.Builder	builder(io.prometheus.metrics.config.PrometheusProperties config)
io.prometheus.metrics.model.snapshots.InfoSnapshot	collect()
void	remove(String... labelValues)	Remove the data point with the specified label values.
void	setLabelValues(String... labelValues)	Set the info label values.

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

setLabelValues

public void setLabelValues(String... labelValues)

Set the info label values. This will replace any previous values, i.e. the info metric will only have one data point after calling setLabelValues(). This is good for a metric like target_info where you want only one single data point.

addLabelValues

public void addLabelValues(String... labelValues)

Create an info data point with the given label values.

remove

public void remove(String... labelValues)

Remove the data point with the specified label values.

collect

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

Specified by:

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

Specified by:

collect in class Metric

builder

public static Info.Builder builder()

builder

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