Update procstat pid_tag documentation

This commit is contained in:
Daniel Nelson 2020-05-14 00:48:05 -07:00
parent 2c56d6de81
commit 68b936c9f0
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
2 changed files with 13 additions and 7 deletions

View File

@ -1,7 +1,7 @@
# Procstat Input Plugin # Procstat Input Plugin
The procstat plugin can be used to monitor the system resource usage of one or more processes. The procstat plugin can be used to monitor the system resource usage of one or more processes.
The procstat_lookup metric displays the query information, The procstat_lookup metric displays the query information,
specifically the number of PIDs returned on a search specifically the number of PIDs returned on a search
Processes can be selected for monitoring using one of several methods: Processes can be selected for monitoring using one of several methods:
@ -44,9 +44,12 @@ Processes can be selected for monitoring using one of several methods:
## When true add the full cmdline as a tag. ## When true add the full cmdline as a tag.
# cmdline_tag = false # cmdline_tag = false
## Add PID as a tag instead of a field; useful to differentiate between ## Add the PID as a tag instead of as a field. When collecting multiple
## processes whose tags are otherwise the same. Can create a large number ## processes with otherwise matching tags this setting should be enabled to
## of series, use judiciously. ## ensure each process has a unique identity.
##
## Enabling this option may result in a large number of series, especially
## when processes have a short lifetime.
# pid_tag = false # pid_tag = false
## Method to use when finding process IDs. Can be one of 'pgrep', or ## Method to use when finding process IDs. Can be one of 'pgrep', or

View File

@ -69,9 +69,12 @@ var sampleConfig = `
## When true add the full cmdline as a tag. ## When true add the full cmdline as a tag.
# cmdline_tag = false # cmdline_tag = false
## Add PID as a tag instead of a field; useful to differentiate between ## Add the PID as a tag instead of as a field. When collecting multiple
## processes whose tags are otherwise the same. Can create a large number ## processes with otherwise matching tags this setting should be enabled to
## of series, use judiciously. ## ensure each process has a unique identity.
##
## Enabling this option may result in a large number of series, especially
## when processes have a short lifetime.
# pid_tag = false # pid_tag = false
## Method to use when finding process IDs. Can be one of 'pgrep', or ## Method to use when finding process IDs. Can be one of 'pgrep', or