Class Counter

Object

Metric

MetricWithFixedMetadata

StatefulMetric<CounterDataPoint, Counter.DataPoint>

Counter

All Implemented Interfaces:

CounterDataPoint, DataPoint, Collector

public class Counter
extends StatefulMetric<CounterDataPoint, Counter.DataPoint>
implements CounterDataPoint

Counter metric.

Example usage:

Counter requestCount = Counter.builder()
    .name("requests_total")
    .help("Total number of requests")
    .labelNames("path", "status")
    .register();
requestCount.labelValues("/hello-world", "200").inc();
requestCount.labelValues("/hello-world", "500").inc();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Counter.Builder

Method Summary

Modifier and Type	Method	Description
static Counter.Builder	builder()
static Counter.Builder	builder(PrometheusProperties config)
CounterSnapshot	collect()	Called when the Prometheus server scrapes metrics.
double	get()	Get the current value.
long	getLongValue()	Get the current value as a long.
MetricType	getMetricType()	Returns the metric type for registration-time validation.
void	inc(double amount)	Add amount.
void	inc(long amount)	Add amount.
void	incWithExemplar(double amount, Labels labels)	Add amount, and create a custom exemplar with the given labels.
void	incWithExemplar(long amount, Labels labels)	Add amount, and create a custom exemplar with the given labels.

Methods inherited from class StatefulMetric

clear, initLabelValues, labelValues, remove, removeIf

Methods inherited from class MetricWithFixedMetadata

getLabelNames, getMetadata, getPrometheusName

Methods inherited from class Object

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

Methods inherited from interface Collector

collect, collect, collect

Methods inherited from interface CounterDataPoint

inc, incWithExemplar

Method Details

inc

public void inc(long amount)

Description copied from interface: CounterDataPoint

Add amount. Throws an IllegalArgumentException if amount is negative.

Specified by:

inc in interface CounterDataPoint

inc

public void inc(double amount)

Description copied from interface: CounterDataPoint

Add amount. Throws an IllegalArgumentException if amount is negative.

Specified by:

inc in interface CounterDataPoint

incWithExemplar

public void incWithExemplar(long amount,
 Labels labels)

Description copied from interface: CounterDataPoint

Add amount, and create a custom exemplar with the given labels. Throws an IllegalArgumentException if amount is negative.

Specified by:

incWithExemplar in interface CounterDataPoint

incWithExemplar

public void incWithExemplar(double amount,
 Labels labels)

Description copied from interface: CounterDataPoint

Add amount, and create a custom exemplar with the given labels. Throws an IllegalArgumentException if amount is negative.

Specified by:

incWithExemplar in interface CounterDataPoint

get

public double get()

Description copied from interface: CounterDataPoint

Get the current value.

Specified by:

get in interface CounterDataPoint

getLongValue

public long getLongValue()

Description copied from interface: CounterDataPoint

Get the current value as a long. Decimal places will be discarded.

Specified by:

getLongValue in interface CounterDataPoint

collect

public CounterSnapshot collect()

Description copied from interface: Collector

Called when the Prometheus server scrapes metrics.

Specified by:

collect in interface Collector

Overrides:

collect in class StatefulMetric<CounterDataPoint, Counter.DataPoint>

getMetricType

public MetricType getMetricType()

Description copied from interface: Collector

Returns the metric type for registration-time validation.

This is used to prevent different metric types (e.g., Counter and Gauge) from sharing the same name. Returning null means type validation is skipped for this collector.

Validation is performed only at registration time. If this method returns null, no type validation is performed for this collector, and duplicate or conflicting metrics may result in invalid exposition output.

Specified by:

getMetricType in interface Collector

Returns:

the metric type, or null to skip validation

builder

public static Counter.Builder builder()

builder

public static Counter.Builder builder(PrometheusProperties config)