Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document new collect_default_jvm_metrics flag for JMXFetch integrations #8153

Merged
merged 3 commits into from
Dec 11, 2020
Merged

Document new collect_default_jvm_metrics flag for JMXFetch integrations #8153

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7221e2
update configs
gh123man Dec 7, 2020
1b6bba0
Feedback
gh123man Dec 10, 2020
7c32c3d
Re-word description
gh123man Dec 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions activemq/datadog_checks/activemq/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions cassandra/datadog_checks/cassandra/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions confluent_platform/datadog_checks/confluent_platform/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
8 changes: 7 additions & 1 deletion datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/jmx.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: Allows disabling the collection of default JVM metrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Allows disabling the collection of default JVM metrics
description: Enables the collection of default JVM metrics

Small nit but feel like this wording would be more clear since it is disabled by default.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry if this was not clear! Actually this defaults to true. Perhaps I should call that out in the doc?
For context - the existing behavior is to collect default JVM metrics but I wanted to add a flag to explicitly disable that.

I thought it may be misleading to have a disable_collect_default_jvm_metrics: true because that logic feels backwards to me.

value:
example: false
gh123man marked this conversation as resolved.
Show resolved Hide resolved
type: boolean

- template: instances/default
5 changes: 5 additions & 0 deletions hazelcast/datadog_checks/hazelcast/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions hive/datadog_checks/hive/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions hivemq/datadog_checks/hivemq/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions ignite/datadog_checks/ignite/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions jboss_wildfly/datadog_checks/jboss_wildfly/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions kafka/datadog_checks/kafka/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions presto/datadog_checks/presto/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions solr/datadog_checks/solr/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions sonarqube/datadog_checks/sonarqube/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down
5 changes: 5 additions & 0 deletions tomcat/datadog_checks/tomcat/data/conf.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ instances:
#
# rmi_client_timeout: 15000

## @param collect_default_jvm_metrics - boolean - optional - default: false
## Allows disabling the collection of default JVM metrics
#
# collect_default_jvm_metrics: false

## @param tags - list of strings - optional
## A list of tags to attach to every metric and service check emitted by this instance.
##
Expand Down