Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class Info.Builder

Object

MetricWithFixedMetadata.Builder<Info.Builder,Info>

Builder

Enclosing class:

Info

public static class Info.Builder
extends MetricWithFixedMetadata.Builder<Info.Builder,Info>

Method Summary

Modifier and Type	Method	Description
Info	build()
Info.Builder	name(String name)	The _info suffix will automatically be appended if it's missing.
Info.Builder	unit(Unit unit)	Throws an UnsupportedOperationException because Info metrics cannot have a unit.

Methods inherited from class MetricWithFixedMetadata.Builder

constLabels, help, labelNames

Methods inherited from class Object

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

Method Details

name

public Info.Builder name(String name)

The _info suffix will automatically be appended if it's missing.

 Info info1 = Info.builder()
     .name("runtime_info")
     .build();
 Info info2 = Info.builder()
     .name("runtime")
     .build();
 

In the example above both info1 and info2 will be named "runtime_info" in Prometheus.

Throws an IllegalArgumentException if MetricMetadata.isValidMetricName(name) is false.

Overrides:

name in class MetricWithFixedMetadata.Builder<Info.Builder,Info>

unit

public Info.Builder unit(Unit unit)

Throws an UnsupportedOperationException because Info metrics cannot have a unit.

Overrides:

unit in class MetricWithFixedMetadata.Builder<Info.Builder,Info>

build

public Info build()

Specified by:

build in class MetricWithFixedMetadata.Builder<Info.Builder,Info>