Document new collect_default_jvm_metrics flag for JMXFetch integratio…

…ns (#8153) * update configs * Feedback * Re-word description
DataDog · Dec 11, 2020 · 4711963 · 4711963
1 parent 986dfdd
commit 4711963
Show file tree

Hide file tree

Showing 14 changed files with 72 additions and 1 deletion.
diff --git a/activemq/datadog_checks/activemq/data/conf.yaml.example b/activemq/datadog_checks/activemq/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/cassandra/datadog_checks/cassandra/data/conf.yaml.example b/cassandra/datadog_checks/cassandra/data/conf.yaml.example
@@ -149,6 +149,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/confluent_platform/datadog_checks/confluent_platform/data/conf.yaml.example b/confluent_platform/datadog_checks/confluent_platform/data/conf.yaml.example
@@ -154,6 +154,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

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
@@ -104,6 +104,12 @@
     will give up on that connection and retry.
   value:
     example: 15000
-    type: number
+    type: number 
+
+- name: collect_default_jvm_metrics
+  description: Configures the collection of default JVM metrics.
+  value:
+    example: true
+    type: boolean
 
 - template: instances/default
diff --git a/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example b/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example
@@ -191,6 +191,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/hive/datadog_checks/hive/data/conf.yaml.example b/hive/datadog_checks/hive/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/hivemq/datadog_checks/hivemq/data/conf.yaml.example b/hivemq/datadog_checks/hivemq/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/ignite/datadog_checks/ignite/data/conf.yaml.example b/ignite/datadog_checks/ignite/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/jboss_wildfly/datadog_checks/jboss_wildfly/data/conf.yaml.example b/jboss_wildfly/datadog_checks/jboss_wildfly/data/conf.yaml.example
@@ -156,6 +156,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/kafka/datadog_checks/kafka/data/conf.yaml.example b/kafka/datadog_checks/kafka/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/presto/datadog_checks/presto/data/conf.yaml.example b/presto/datadog_checks/presto/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/solr/datadog_checks/solr/data/conf.yaml.example b/solr/datadog_checks/solr/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example b/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example
@@ -229,6 +229,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

diff --git a/tomcat/datadog_checks/tomcat/data/conf.yaml.example b/tomcat/datadog_checks/tomcat/data/conf.yaml.example
@@ -143,6 +143,11 @@ instances:
     #
     # rmi_client_timeout: 15000
 
+    ## @param collect_default_jvm_metrics - boolean - optional - default: true
+    ## Configures the collection of default JVM metrics.
+    #
+    # collect_default_jvm_metrics: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##