Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class MetricWithFixedMetadata.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>

java.lang.Object

io.prometheus.metrics.core.metrics.Metric.Builder<B,M>

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder<B,M>

Direct Known Subclasses:

Counter.Builder, CounterWithCallback.Builder, Gauge.Builder, GaugeWithCallback.Builder, Histogram.Builder, Info.Builder, StateSet.Builder, Summary.Builder, SummaryWithCallback.Builder

Enclosing class:

MetricWithFixedMetadata

public abstract static class MetricWithFixedMetadata.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>
extends Metric.Builder<B,M>

Field Summary

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

constLabels, illegalLabelNames, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(List<String> illegalLabelNames, io.prometheus.metrics.config.PrometheusProperties properties)

Method Summary

Modifier and Type	Method	Description
abstract M	build()
B	constLabels(io.prometheus.metrics.model.snapshots.Labels constLabels)
B	help(String help)
B	labelNames(String... labelNames)
B	name(String name)
protected B	nameWithOriginal(String name, String originalName)	Set the metric name and original name separately.
protected abstract B	self()
B	unit(io.prometheus.metrics.model.snapshots.Unit unit)

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

protected Builder(List<String> illegalLabelNames,
 io.prometheus.metrics.config.PrometheusProperties properties)

Method Details

name

public B name(String name)

nameWithOriginal

protected B nameWithOriginal(String name,
 String originalName)

Set the metric name and original name separately. Used by Counter and Info builders which strip type suffixes from the name but preserve the original for exposition.

unit

public B unit(@Nullable
 io.prometheus.metrics.model.snapshots.Unit unit)

help

public B help(String help)

labelNames

public B labelNames(String... labelNames)

constLabels

public B constLabels(io.prometheus.metrics.model.snapshots.Labels constLabels)

Overrides:

constLabels in class Metric.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>

build

public abstract M build()

Specified by:

build in class Metric.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>

self

protected abstract B self()

Specified by:

self in class Metric.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>