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:

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

Modifier and Type	Field	Description
private final Set<Labels>	labels

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

labelNames

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

constLabels

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Info(Info.Builder builder)

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(PrometheusProperties config)
InfoSnapshot	collect()	Called when the Prometheus server scrapes metrics.
MetricType	getMetricType()	Returns the metric type for registration-time validation.
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

getLabelNames, 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

Field Details

labels

private final Set<Labels> labels

Constructor Details

Info

private Info(Info.Builder builder)

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 InfoSnapshot collect()

Description copied from interface: Collector

Called when the Prometheus server scrapes metrics.

Specified by:

collect in interface Collector

Specified by:

collect in class Metric

getMetricType

public MetricType getMetricType()

Description copied from interface: Collector

Returns the metric type for registration-time validation.

This is used to prevent different metric types (e.g., Counter and Gauge) from sharing the same name. Returning null means type validation is skipped for this collector.

Validation is performed only at registration time. If this method returns null, no type validation is performed for this collector, and duplicate or conflicting metrics may result in invalid exposition output.

Returns:

the metric type, or null to skip validation

builder

public static Info.Builder builder()

builder

public static Info.Builder builder(PrometheusProperties config)