Package io.prometheus.metrics.core.metrics

Class Info.Builder

java.lang.Object

io.prometheus.metrics.core.metrics.Metric.Builder<Info.Builder,Info>

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder<Info.Builder,Info>

io.prometheus.metrics.core.metrics.Info.Builder

Enclosing class:

Info

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

Field Summary

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

constLabels, illegalLabelNames, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(PrometheusProperties config)

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.
protected Info.Builder	self()
private static String	stripInfoSuffix(String name)
Info.Builder	unit(Unit unit)	Throws an UnsupportedOperationException because Info metrics cannot have a unit.

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

constLabels, help, labelNames

Methods inherited from class io.prometheus.metrics.core.metrics.Metric.Builder

register, register

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

private Builder(PrometheusProperties config)

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>

stripInfoSuffix

private static String stripInfoSuffix(String name)

build

public Info build()

Specified by:

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

self

protected Info.Builder self()

Specified by:

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