Skip to content

Commit eb87212

Browse files
jhgilbertmirzanurkic-ddbrett0000FF
authored
Update example commands (#17357)
* Update example commands * update jmx subcommands, modify formatting * Editorial pass * Update tomcat/README.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> * Update tomcat/README.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> --------- Co-authored-by: Mirza Nurkic <mirza.nurkic@datadoghq.com> Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com>
1 parent 465fba5 commit eb87212

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

tomcat/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -228,20 +228,20 @@ See the [JMX Check documentation][7] for more detailed information.
228228

229229
### Commands to view the available metrics
230230

231-
The `datadog-agent jmx` command was added in version 4.1.0.
232-
233-
- List attributes that match at least one of your instance configurations:
234-
`sudo /etc/init.d/datadog-agent jmx list_matching_attributes`
235-
- List attributes that match one of your instance configurations but that are not collected because it would exceed the number of metrics that can be collected:
236-
`sudo /etc/init.d/datadog-agent jmx list_limited_attributes`
237-
- List attributes that are actually collected by your current instance configurations:
238-
`sudo /etc/init.d/datadog-agent jmx list_collected_attributes`
239-
- List attributes that don't match any of your instance configurations:
240-
`sudo /etc/init.d/datadog-agent jmx list_not_matching_attributes`
241-
- List every attribute available that has a type supported by JMXFetch:
242-
`sudo /etc/init.d/datadog-agent jmx list_everything`
243-
- Start the collection of metrics based on your current configuration and display them in the console:
244-
`sudo /etc/init.d/datadog-agent jmx collect`
231+
The `datadog-agent jmx` command allows you to run troubleshooting commands on JMXFetch integrations. On Linux systems, you will need to prepend the command with `sudo -u dd-agent` so that the Datadog Agent runs as the correct user.
232+
233+
#### datadog-agent jmx collect
234+
Running `datadog-agent jmx collect` starts the collection of metrics based on your current configuration and displays them in the console.
235+
236+
#### datadog-agent jmx list
237+
The `datadog-agent jmx list` has a number of available subcommands:
238+
- `collected` - List attributes that will actually be collected by your current instance's configuration.
239+
- `everything` - List every attribute available that has a type supported by JMXFetch.
240+
- `limited` - List attributes that match one of your instances' configurations but that are not being collected because it would exceed the number of metrics that can be collected.
241+
- `matching` - List attributes that match at least one of your instances' configurations.
242+
- `not-matching` - List attributes that don't match any of your instances' configurations.
243+
- `with-metrics` - List attributes and metrics data that match at least one of your instances' configurations.
244+
- `with-rate-metrics` - List attributes and metrics data that match at least one of your instances' configurations, including rates and counters.
245245

246246
## Further Reading
247247

0 commit comments

Comments
 (0)