Package io.prometheus.metrics.core.metrics

Class Counter.Builder

Object

MetricWithFixedMetadata.Builder<Counter.Builder,Counter>

Builder

Enclosing class:

Counter

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

Method Summary

Modifier and Type	Method	Description
Counter	build()
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.
Counter.Builder	withExemplars()	Allow Exemplars for this metric.
Counter.Builder	withoutExemplars()	Turn off Exemplars for this metric.

Methods inherited from class MetricWithFixedMetadata.Builder

constLabels, help, labelNames, unit

Methods inherited from class Object

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

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>

withExemplars

public Counter.Builder withExemplars()

Allow Exemplars for this metric.

withoutExemplars

public Counter.Builder withoutExemplars()

Turn off Exemplars for this metric.

getDefaultProperties

public MetricsProperties getDefaultProperties()

Override if there are more properties than just exemplars enabled.