Package io.prometheus.jmx

Class ObjectNameAttributeFilter

java.lang.Object

io.prometheus.jmx.ObjectNameAttributeFilter

public class ObjectNameAttributeFilter
extends Object

Class to implement filtering of an MBean's attributes based on the attribute's name

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES	Configuration constant to enable auto ObjectName attributes filtering
static final String	EXCLUDE_OBJECT_NAME_ATTRIBUTES	Configuration constant to define a mapping of ObjectNames to attribute names

Method Summary

Modifier and Type	Method	Description
void	add(ObjectName objectName, String attributeName)	Method to add an attribute name to the filter if dynamic exclusion is enabled
static ObjectNameAttributeFilter	create(Map<String,Object> yamlConfig)	Method to create an ObjectNameAttributeFilter
boolean	exclude(ObjectName objectName, String attributeName)	Method to check if an attribute should be excluded

Methods inherited from class java.lang.Object

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

Field Details

EXCLUDE_OBJECT_NAME_ATTRIBUTES

public static final String EXCLUDE_OBJECT_NAME_ATTRIBUTES

Configuration constant to define a mapping of ObjectNames to attribute names

See Also:

• Constant Field Values

AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES

public static final String AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES

Configuration constant to enable auto ObjectName attributes filtering

See Also:

• Constant Field Values

Method Details

add

public void add(ObjectName objectName,
 String attributeName)

Method to add an attribute name to the filter if dynamic exclusion is enabled

Parameters:

objectName - the ObjectName

attributeName - the attribute name

exclude

public boolean exclude(ObjectName objectName,
 String attributeName)

Method to check if an attribute should be excluded

Parameters:

objectName - the ObjectName

attributeName - the attribute name

Returns:

true if it should be excluded, false otherwise

create

public static ObjectNameAttributeFilter create(Map<String,Object> yamlConfig)

Method to create an ObjectNameAttributeFilter

Parameters:

yamlConfig - yamlConfig

Returns:

an ObjectNameAttributeFilter