Skip to main content
1.6.0

Object Names and Attribute Filters

ObjectName filters limit which MBeans and attributes the collector processes.

MBean filters

KeyDescription
includeObjectNamesList of ObjectName patterns to query. Defaults to all MBeans.
excludeObjectNamesList of ObjectName patterns not to query. Takes precedence over includes. Defaults to none.
whitelistObjectNamesCompatibility alias for includeObjectNames; supported but discouraged.
blacklistObjectNamesCompatibility alias for excludeObjectNames; supported but discouraged.
excludeJvmMetricsWhen true, adds common JVM ObjectName patterns to the exclude list. Only relevant for the Java agent.
includeObjectNames:
- java.lang:type=Memory
- java.lang:type=GarbageCollector,name=*
excludeObjectNames:
- java.lang:type=MemoryPool,name=CodeHeap*
rules:
- pattern: ".*"

Attribute filters

KeyDescription
includeObjectNameAttributesMap of ObjectName strings to attributes to include.
excludeObjectNameAttributesMap of ObjectName strings to attributes to exclude.
autoExcludeObjectNameAttributesAutomatically exclude attributes that cannot be converted to metrics. Default is true.

ObjectName keys are parsed as javax.management.ObjectName values. Attribute names are matched as strings.

includeObjectNameAttributes:
"java.lang:type=Memory":
- HeapMemoryUsage
excludeObjectNameAttributes:
"java.lang:type=Threading":
- AllThreadIds
autoExcludeObjectNameAttributes: true
rules:
- pattern: ".*"