Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.registry

Class MetricNameFilter.Builder

java.lang.Object

io.prometheus.metrics.model.registry.MetricNameFilter.Builder

Enclosing class:

MetricNameFilter

public static class MetricNameFilter.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetricNameFilter	build()
MetricNameFilter.Builder	nameMustBeEqualTo(String... names)
MetricNameFilter.Builder	nameMustBeEqualTo(Collection<String> names)	Only samples with one of the names will be included.
MetricNameFilter.Builder	nameMustNotBeEqualTo(String... names)
MetricNameFilter.Builder	nameMustNotBeEqualTo(Collection<String> names)	All samples that are not in names will be excluded.
MetricNameFilter.Builder	nameMustNotStartWith(String... prefixes)
MetricNameFilter.Builder	nameMustNotStartWith(Collection<String> prefixes)	Samples with names starting with one of the prefixes will be excluded.
MetricNameFilter.Builder	nameMustStartWith(String... prefixes)
MetricNameFilter.Builder	nameMustStartWith(Collection<String> prefixes)	Only samples whose name starts with one of the prefixes will be included.

Methods inherited from class java.lang.Object

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

Method Details

nameMustBeEqualTo

public MetricNameFilter.Builder nameMustBeEqualTo(String... names)

See Also:

• nameMustBeEqualTo(Collection)

nameMustBeEqualTo

public MetricNameFilter.Builder nameMustBeEqualTo(Collection<String> names)

Only samples with one of the names will be included.

Note that the provided names will be matched against the sample name (i.e. the time series name) and not the metric name. For instance, to retrieve all samples from a histogram, you must include the '_count', '_sum' and '_bucket' names.

This method should be used by HTTP exporters to implement the ?name[]= URL parameters.

Parameters:

names - empty means no restriction.

nameMustNotBeEqualTo

public MetricNameFilter.Builder nameMustNotBeEqualTo(String... names)

See Also:

• nameMustNotBeEqualTo(Collection)

nameMustNotBeEqualTo

public MetricNameFilter.Builder nameMustNotBeEqualTo(Collection<String> names)

All samples that are not in names will be excluded.

Note that the provided names will be matched against the sample name (i.e. the time series name) and not the metric name. For instance, to exclude all samples from a histogram, you must exclude the '_count', '_sum' and '_bucket' names.

Parameters:

names - empty means no name will be excluded.

nameMustStartWith

public MetricNameFilter.Builder nameMustStartWith(String... prefixes)

See Also:

• nameMustStartWith(Collection)

nameMustStartWith

public MetricNameFilter.Builder nameMustStartWith(Collection<String> prefixes)

Only samples whose name starts with one of the prefixes will be included.

Parameters:

prefixes - empty means no restriction.

nameMustNotStartWith

public MetricNameFilter.Builder nameMustNotStartWith(String... prefixes)

See Also:

• nameMustNotStartWith(Collection)

nameMustNotStartWith

public MetricNameFilter.Builder nameMustNotStartWith(Collection<String> prefixes)

Samples with names starting with one of the prefixes will be excluded.

Parameters:

prefixes - empty means no time series will be excluded.

build

public MetricNameFilter build()