Class ExporterFilterProperties

java.lang.Object

io.prometheus.metrics.config.ExporterFilterProperties

public class ExporterFilterProperties
extends Object

Properties starting with io.prometheus.exporter.filter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExporterFilterProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	allowedNames
private final List<String>	allowedPrefixes
private final List<String>	excludedNames
private final List<String>	excludedPrefixes
static final String	METRIC_NAME_MUST_BE_EQUAL_TO
static final String	METRIC_NAME_MUST_NOT_BE_EQUAL_TO
static final String	METRIC_NAME_MUST_NOT_START_WITH
static final String	METRIC_NAME_MUST_START_WITH
private static final String	PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExporterFilterProperties(List<String> allowedNames, List<String> excludedNames, List<String> allowedPrefixes, List<String> excludedPrefixes)

Method Summary

Modifier and Type	Method	Description
static ExporterFilterProperties.Builder	builder()
List<String>	getAllowedMetricNamePrefixes()
List<String>	getAllowedMetricNames()
List<String>	getExcludedMetricNamePrefixes()
List<String>	getExcludedMetricNames()
(package private) static ExporterFilterProperties	load(PropertySource propertySource)	Note that this will remove entries from propertySource.

Methods inherited from class Object

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

Field Details

METRIC_NAME_MUST_BE_EQUAL_TO

public static final String METRIC_NAME_MUST_BE_EQUAL_TO

See Also:

• Constant Field Values

METRIC_NAME_MUST_NOT_BE_EQUAL_TO

public static final String METRIC_NAME_MUST_NOT_BE_EQUAL_TO

See Also:

• Constant Field Values

METRIC_NAME_MUST_START_WITH

public static final String METRIC_NAME_MUST_START_WITH

See Also:

• Constant Field Values

METRIC_NAME_MUST_NOT_START_WITH

public static final String METRIC_NAME_MUST_NOT_START_WITH

See Also:

• Constant Field Values

PREFIX

private static final String PREFIX

See Also:

• Constant Field Values

allowedNames

private final List<String> allowedNames

excludedNames

private final List<String> excludedNames

allowedPrefixes

private final List<String> allowedPrefixes

excludedPrefixes

private final List<String> excludedPrefixes

Constructor Details

ExporterFilterProperties

private ExporterFilterProperties(List<String> allowedNames,
 List<String> excludedNames,
 List<String> allowedPrefixes,
 List<String> excludedPrefixes)

Method Details

getAllowedMetricNames

public List<String> getAllowedMetricNames()

getExcludedMetricNames

public List<String> getExcludedMetricNames()

getAllowedMetricNamePrefixes

public List<String> getAllowedMetricNamePrefixes()

getExcludedMetricNamePrefixes

public List<String> getExcludedMetricNamePrefixes()

load

static ExporterFilterProperties load(PropertySource propertySource)
                              throws PrometheusPropertiesException

Note that this will remove entries from propertySource. This is because we want to know if there are unused properties remaining after all properties have been loaded.

Throws:

PrometheusPropertiesException

builder

public static ExporterFilterProperties.Builder builder()