Enabled auto object name attribute filtering by default (#871)

Signed-off-by: Doug Hoard <[email protected]>

Author: dhoard

README.md

@@ -83,6 +83,7 @@ lowercaseOutputName: false
 lowercaseOutputLabelNames: false
 includeObjectNames: ["org.apache.cassandra.metrics:*"]
 excludeObjectNames: ["org.apache.cassandra.metrics:type=ColumnFamily,*"]
+autoExcludeObjectNameAttributes: true
 excludeObjectNameAttributes:
   "java.lang:type=OperatingSystem":
     - "ObjectName"
@@ -112,7 +113,7 @@ lowercaseOutputName | Lowercase the output metric name. Applies to default forma
 lowercaseOutputLabelNames | Lowercase the output metric label names. Applies to default format and `labels`. Defaults to false.
 includeObjectNames | A list of [ObjectNames](http://docs.oracle.com/javase/6/docs/api/javax/management/ObjectName.html) to query. Defaults to all mBeans.
 excludeObjectNames | A list of [ObjectNames](http://docs.oracle.com/javase/6/docs/api/javax/management/ObjectName.html) to not query. Takes precedence over `includeObjectNames`. Defaults to none.
-excludeObjectNameAttributesDynamic | Whether to use dynamic [ObjectName](http://docs.oracle.com/javase/6/docs/api/javax/management/ObjectName.html) attribute filtering. Defaults to false. 
+autoExcludeObjectNameAttributes | Whether to use auto add [ObjectName](http://docs.oracle.com/javase/6/docs/api/javax/management/ObjectName.html) attributes that can't be converted to standard metrics types. Defaults to `true`. 
 excludeObjectNameAttributes | Optional a map of [ObjectNames](http://docs.oracle.com/javase/6/docs/api/javax/management/ObjectName.html) with a list of attribute names. 
 rules      | A list of rules to apply in order, processing stops at the first matching rule. Attributes that aren't matched aren't collected. If not specified, defaults to collecting everything in the default format.
 pattern           | Regex pattern to match against each bean attribute. The pattern is not anchored. Capture groups can be used in other options. Defaults to matching everything.

collector/src/main/java/io/prometheus/jmx/JmxScraper.java

@@ -217,11 +217,11 @@ private void scrapeBean(MBeanServerConnection beanConn, ObjectName mBeanName) {
                 Attribute attribute = (Attribute) object;
                 String attributeName = attribute.getName();
                 if (mBeanName.toString().equals("java.lang:type=Runtime")
-                                && (attributeName.equalsIgnoreCase("SystemProperties")
-                                        || attributeName.equalsIgnoreCase("ClassPath")
-                                        || attributeName.equalsIgnoreCase("BootClassPath"))
-                        || attributeName.equalsIgnoreCase("LibraryPath")) {
-                    // Skip attributes for the "java.lang:type=Runtime" MBean because
+                        && (attributeName.equalsIgnoreCase("SystemProperties")
+                                || attributeName.equalsIgnoreCase("ClassPath")
+                                || attributeName.equalsIgnoreCase("BootClassPath")
+                                || attributeName.equalsIgnoreCase("LibraryPath"))) {
+                    // Skip this attributes for the "java.lang:type=Runtime" MBean because
                     // getting the values is expensive and the values are ultimately ignored
                     continue;
                 } else if (mBeanName.toString().equals("jdk.management.jfr:type=FlightRecorder")) {

collector/src/main/java/io/prometheus/jmx/ObjectNameAttributeFilter.java

@@ -16,29 +16,34 @@
 
 package io.prometheus.jmx;
 
+import io.prometheus.jmx.logger.Logger;
+import io.prometheus.jmx.logger.LoggerFactory;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.logging.Level;
 import javax.management.MalformedObjectNameException;
 import javax.management.ObjectName;
 
 /** Class to implement filtering of an MBean's attributes based on the attribute's name */
 @SuppressWarnings("unchecked")
 public class ObjectNameAttributeFilter {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(ObjectNameAttributeFilter.class);
+
     /** Configuration constant to define a mapping of ObjectNames to attribute names */
     public static final String EXCLUDE_OBJECT_NAME_ATTRIBUTES = "excludeObjectNameAttributes";
 
-    /** Configuration constant to enable dynamic support of ObjectName attributes filtering */
-    public static final String EXCLUDE_OBJECT_NAME_ATTRIBUTES_DYNAMIC =
-            EXCLUDE_OBJECT_NAME_ATTRIBUTES + "Dynamic";
+    /** Configuration constant to enable auto ObjectName attributes filtering */
+    public static final String AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES =
+            "autoExcludeObjectNameAttributes";
 
     private final Map<ObjectName, Set<String>> excludeObjectNameAttributesMap;
 
-    private boolean dynamicExclusion;
+    private boolean autoExcludeObjectNameAttributes;
 
     /** Constructor */
     private ObjectNameAttributeFilter() {
@@ -68,17 +73,27 @@ private ObjectNameAttributeFilter initialize(Map<String, Object> yamlConfig)
                                 objectName, o -> Collections.synchronizedSet(new HashSet<>()));
 
                 for (String attributeName : attributeNames) {
+                    LOGGER.log(
+                            Level.FINE,
+                            "excluding object name [%d] attribute name [%s]",
+                            objectName.getCanonicalName(),
+                            attributeName);
                     attributeNameSet.add(attributeName);
                 }
 
                 excludeObjectNameAttributesMap.put(objectName, attributeNameSet);
             }
         }
 
-        if (yamlConfig.containsKey(EXCLUDE_OBJECT_NAME_ATTRIBUTES_DYNAMIC)) {
-            dynamicExclusion = (Boolean) yamlConfig.get(EXCLUDE_OBJECT_NAME_ATTRIBUTES_DYNAMIC);
+        if (yamlConfig.containsKey(AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES)) {
+            autoExcludeObjectNameAttributes =
+                    (Boolean) yamlConfig.get(AUTO_EXCLUDE_OBJECT_NAME_ATTRIBUTES);
+        } else {
+            autoExcludeObjectNameAttributes = true;
         }
 
+        LOGGER.log(Level.FINE, "dynamicExclusion [%b]", autoExcludeObjectNameAttributes);
+
         return this;
     }
 
@@ -89,11 +104,17 @@ private ObjectNameAttributeFilter initialize(Map<String, Object> yamlConfig)
      * @param attributeName the attribute name
      */
     public void add(ObjectName objectName, String attributeName) {
-        if (dynamicExclusion) {
+        if (autoExcludeObjectNameAttributes) {
             Set<String> attribteNameSet =
                     excludeObjectNameAttributesMap.computeIfAbsent(
                             objectName, o -> Collections.synchronizedSet(new HashSet<>()));
 
+            LOGGER.log(
+                    Level.FINE,
+                    "auto adding exclusion of object name [%s] attribute name [%s]",
+                    objectName.getCanonicalName(),
+                    attributeName);
+
             attribteNameSet.add(attributeName);
         }
     }

collector/src/main/java/io/prometheus/jmx/logger/Logger.java

@@ -23,6 +23,10 @@ public class Logger {
 
     private final java.util.logging.Logger LOGGER;
 
+    private final boolean JMX_PROMETHEUS_EXPORTER_DEVELOPER_DEBUG =
+            "true".equals(System.getenv("JMX_PROMETHEUS_EXPORTER_DEVELOPER_DEBUG"))
+                    || "true".equals(System.getProperty("jmx.prometheus.exporter.developer.debug"));
+
     /**
      * Constructor
      *
@@ -53,5 +57,11 @@ public void log(Level level, String message, Object... objects) {
         if (LOGGER.isLoggable(level)) {
             LOGGER.log(level, String.format(message, objects));
         }
+
+        if (JMX_PROMETHEUS_EXPORTER_DEVELOPER_DEBUG) {
+            System.out
+                    .format("[%s] %s %s", level, LOGGER.getName(), String.format(message, objects))
+                    .println();
+        }
     }
 }

…amicExcludeObjectNameAttributesTest.java …AutoExcludeObjectNameAttributesTest.javaintegration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/DynamicExcludeObjectNameAttributesTest.java renamed to integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/DisableAutoExcludeObjectNameAttributesTest.java integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/DynamicExcludeObjectNameAttributesTest.java renamed to integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/DisableAutoExcludeObjectNameAttributesTest.java

@@ -33,7 +33,8 @@
 import java.util.Set;
 import org.antublue.test.engine.api.TestEngine;
 
-public class DynamicExcludeObjectNameAttributesTest extends BaseTest implements ContentConsumer {
+public class DisableAutoExcludeObjectNameAttributesTest extends BaseTest
+        implements ContentConsumer {
 
     @TestEngine.Test
     public void testHealthy() {

…eAttributesTest/JavaAgent/application.sh …eAttributesTest/JavaAgent/application.shintegration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/DynamicExcludeObjectNameAttributesTest/JavaAgent/application.sh renamed to integration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/DisableAutoExcludeObjectNameAttributesTest/JavaAgent/application.sh integration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/DynamicExcludeObjectNameAttributesTest/JavaAgent/application.sh renamed to integration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/DisableAutoExcludeObjectNameAttributesTest/JavaAgent/application.sh

@@ -0,0 +1,3 @@
+autoExcludeObjectNameAttributes: false
+rules:
+  - pattern: ".*"

integration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/DisableAutoExcludeObjectNameAttributesTest/JavaAgent/exporter.yaml

@@ -0,0 +1,4 @@
+hostPort: application:9999
+autoExcludeObjectNameAttributes: false
+rules:
+  - pattern: ".*"