Package io.prometheus.client

Class SampleNameFilter

java.lang.Object

io.prometheus.client.SampleNameFilter

All Implemented Interfaces:

Predicate<String>

public class SampleNameFilter
extends Object
implements Predicate<String>

Filter samples (i.e. time series) by name.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SampleNameFilter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static Predicate<String>	ALLOW_ALL	For convenience, a filter that allows all names.

Method Summary

Modifier and Type	Method	Description
Predicate<String>	and(Predicate<? super String> other)	Replacement for Java 8's Predicate.and() for compatibility with Java versions < 8.
static Predicate<String>	restrictToNamesEqualTo(Predicate<String> filter, Collection<String> allowedNames)	Helper method to compose a filter such that Sample names must match the existing filter and be in the list of allowedNames This should be used to implement the names[] query parameter in HTTP exporters.
static List<String>	stringToList(String s)	Helper method to deserialize a delimiter-separated list of Strings into a List<String>.
boolean	test(String sampleName)

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_ALL

public static final Predicate<String> ALLOW_ALL

For convenience, a filter that allows all names.

Method Detail

test

public boolean test(String sampleName)

Specified by:

test in interface Predicate<String>

and

public Predicate<String> and(Predicate<? super String> other)

Replacement for Java 8's Predicate.and() for compatibility with Java versions < 8.

stringToList

public static List<String> stringToList(String s)

Helper method to deserialize a delimiter-separated list of Strings into a List<String>.

delimiter is one of , ; \t \n.

This is implemented here so that exporters can provide a consistent configuration format for lists of allowed names.

restrictToNamesEqualTo

public static Predicate<String> restrictToNamesEqualTo(Predicate<String> filter,
                                                       Collection<String> allowedNames)

Helper method to compose a filter such that Sample names must

• match the existing filter
• and be in the list of allowedNames

This should be used to implement the names[] query parameter in HTTP exporters.

Parameters:

filter - may be null, indicating that the resulting filter should just filter by allowedNames.

allowedNames - may be null or empty, indicating that filter is returned unmodified.

Returns:

a filter combining the exising filter and the allowedNames, or null if both parameters were null.