Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class Counter.Builder

java.lang.Object

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

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

io.prometheus.metrics.core.metrics.Counter.Builder

Enclosing class:

Counter

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	exemplarsEnabled

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

constLabels, illegalLabelNames, properties

Method Summary

Modifier and Type	Method	Description
Counter	build()
io.prometheus.metrics.config.MetricsProperties	getDefaultProperties()	Override if there are more properties than just exemplars enabled.
Counter.Builder	name(String name)	The _total suffix will automatically be appended if it's missing.
protected Counter.Builder	self()
protected io.prometheus.metrics.config.MetricsProperties	toProperties()	Override if there are more properties than just exemplars enabled.
Counter.Builder	withExemplars()	Allow Exemplars for this metric.
Counter.Builder	withoutExemplars()	Turn off Exemplars for this metric.

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

constLabels, help, labelNames, 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

Field Details

exemplarsEnabled

@Nullable
protected Boolean exemplarsEnabled

Method Details

name

public Counter.Builder name(String name)

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

 Counter c1 = Counter.builder()
     .name("events_total")
     .build();
 Counter c2 = Counter.builder()
     .name("events")
     .build();
 

In the example above both c1 and c2 would be named "events_total" in Prometheus.

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

Overrides:

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

build

public Counter build()

Specified by:

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

self

protected Counter.Builder self()

Specified by:

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

withExemplars

public Counter.Builder withExemplars()

Allow Exemplars for this metric.

withoutExemplars

public Counter.Builder withoutExemplars()

Turn off Exemplars for this metric.

toProperties

protected io.prometheus.metrics.config.MetricsProperties toProperties()

Override if there are more properties than just exemplars enabled.

getDefaultProperties

public io.prometheus.metrics.config.MetricsProperties getDefaultProperties()

Override if there are more properties than just exemplars enabled.