From 82e8666688acf94fc0b718bc1c9bab0f1ad5990a Mon Sep 17 00:00:00 2001 From: Brian Floersch Date: Fri, 11 Dec 2020 10:16:51 -0500 Subject: [PATCH] Document new collect_default_jvm_metrics flag for JMXFetch (#6923) * update JMX docs * release notes * better doc string * update docs to match integrations --- cmd/agent/dist/conf.d/jmx.d/conf.yaml.example | 5 +++++ ...collect_default_jvm_metrics-ebdc0ad0f00f6b07.yaml | 12 ++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 releasenotes/notes/collect_default_jvm_metrics-ebdc0ad0f00f6b07.yaml diff --git a/cmd/agent/dist/conf.d/jmx.d/conf.yaml.example b/cmd/agent/dist/conf.d/jmx.d/conf.yaml.example index 3b5fbf442b3e9..d61bb7d8cd902 100644 --- a/cmd/agent/dist/conf.d/jmx.d/conf.yaml.example +++ b/cmd/agent/dist/conf.d/jmx.d/conf.yaml.example @@ -146,3 +146,8 @@ instances: # exclude: # bean_regex: # - + + ## @param collect_default_jvm_metrics - boolean - optional - default: true + ## Configures the collection of default JVM metrics. + # + # collect_default_jvm_metrics: true diff --git a/releasenotes/notes/collect_default_jvm_metrics-ebdc0ad0f00f6b07.yaml b/releasenotes/notes/collect_default_jvm_metrics-ebdc0ad0f00f6b07.yaml new file mode 100644 index 0000000000000..3b9d7afcb1704 --- /dev/null +++ b/releasenotes/notes/collect_default_jvm_metrics-ebdc0ad0f00f6b07.yaml @@ -0,0 +1,12 @@ +# Each section from every releasenote are combined when the +# CHANGELOG.rst is rendered. So the text needs to be worded so that +# it does not depend on any information only available in another +# section. This may mean repeating some details, but each section +# must be readable independently of the other. +# +# Each section note must be formatted as reStructuredText. +--- +enhancements: + - | + Added new config option for JMXFetch collect_default_jvm_metrics that enables/disables + default JVM metric collection.