Fix description of jmx options (#10454)

* Fix description of jmx option * Update conf.yaml.example * Update process_name_regex * Apply suggestions
DataDog · Oct 20, 2021 · 106a41a · 106a41a
1 parent 6a548c1
commit 106a41a
Show file tree

Hide file tree

Showing 15 changed files with 120 additions and 30 deletions.
diff --git a/activemq/datadog_checks/activemq/data/conf.yaml.example b/activemq/datadog_checks/activemq/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/cassandra/datadog_checks/cassandra/data/conf.yaml.example b/cassandra/datadog_checks/cassandra/data/conf.yaml.example
@@ -84,12 +84,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/confluent_platform/datadog_checks/confluent_platform/data/conf.yaml.example b/confluent_platform/datadog_checks/confluent_platform/data/conf.yaml.example
@@ -89,12 +89,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/jmx.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/jmx.yaml
@@ -41,13 +41,19 @@
     This requires the JDK to be installed and the path to tools.jar to be set below.
     Note: It needs to be set when process_name_regex parameter is set
     e.g. .*process_name.*
+
+    Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    This option is supported in Java 8 and below.
   value:
     type: string
 
 - name: tools_jar_path
   description: |
-    The tool.jar path to be used with the `process_name_regex` parameter,
-    for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    The tools.jar path to be used with the `process_name_regex` parameter,
+    for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+
+    Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    This option is supported in Java 8 and below.
   value:
     type: string
 

diff --git a/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example b/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example
@@ -126,12 +126,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/hive/datadog_checks/hive/data/conf.yaml.example b/hive/datadog_checks/hive/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/hivemq/datadog_checks/hivemq/data/conf.yaml.example b/hivemq/datadog_checks/hivemq/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/hudi/datadog_checks/hudi/data/conf.yaml.example b/hudi/datadog_checks/hudi/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/ignite/datadog_checks/ignite/data/conf.yaml.example b/ignite/datadog_checks/ignite/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/jboss_wildfly/datadog_checks/jboss_wildfly/data/conf.yaml.example b/jboss_wildfly/datadog_checks/jboss_wildfly/data/conf.yaml.example
@@ -91,12 +91,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/kafka/datadog_checks/kafka/data/conf.yaml.example b/kafka/datadog_checks/kafka/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/presto/datadog_checks/presto/data/conf.yaml.example b/presto/datadog_checks/presto/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/solr/datadog_checks/solr/data/conf.yaml.example b/solr/datadog_checks/solr/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example b/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example
@@ -463,12 +463,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>
 

diff --git a/tomcat/datadog_checks/tomcat/data/conf.yaml.example b/tomcat/datadog_checks/tomcat/data/conf.yaml.example
@@ -78,12 +78,18 @@ instances:
     ## This requires the JDK to be installed and the path to tools.jar to be set below.
     ## Note: It needs to be set when process_name_regex parameter is set
     ## e.g. .*process_name.*
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # process_name_regex: <PROCESS_NAME_REGEX>
 
     ## @param tools_jar_path - string - optional
-    ## The tool.jar path to be used with the `process_name_regex` parameter,
-    ## for example: /usr/lib/jvm/java-11-openjdk-amd64/lib/tools.jar
+    ## The tools.jar path to be used with the `process_name_regex` parameter,
+    ## for example: /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
+    ##
+    ## Note: tools.jar was removed in Java 9: https://openjdk.java.net/jeps/220.
+    ## This option is supported in Java 8 and below.
     #
     # tools_jar_path: <TOOLS_JAR_PATH>