dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve procstat input documentation (#2699) 

closes #1895
This commit is contained in:
Alexander Blagoev 2017-04-24 21:18:55 +03:00 committed by Daniel Nelson
parent 06baf7cf78
commit 3c28b93514
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/inputs/procstat/README.md
View File

@ -5,8 +5,6 @@
The procstat plugin can be used to monitor system resource usage by an The procstat plugin can be used to monitor system resource usage by an
individual process using their /proc data. individual process using their /proc data.
The plugin will tag processes by their PID and their process name.
Processes can be specified either by pid file, by executable name, by command Processes can be specified either by pid file, by executable name, by command
line pattern matching, or by username (in this order or priority. Procstat line pattern matching, or by username (in this order or priority. Procstat
plugin will use `pgrep` when executable name is provided to obtain the pid. plugin will use `pgrep` when executable name is provided to obtain the pid.
@ -14,6 +12,19 @@ Procstat plugin will transmit IO, memory, cpu, file descriptor related
measurements for every process specified. A prefix can be set to isolate measurements for every process specified. A prefix can be set to isolate
individual process specific measurements. individual process specific measurements.
The plugin will tag processes according to how they are specified in the configuration. If a pid file is used, a "pidfile" tag will be generated.
On the other hand, if an executable is used an "exe" tag will be generated. Possible tag names:
* pidfile
* exe
* pattern
* user
Additionally the plugin will tag processes by their PID (pid_tag = true in the config) and their process name:
* pid
* process_name
Example: Example:
``` ```
@ -28,8 +39,8 @@ Example:
The above configuration would result in output like: The above configuration would result in output like:
``` ```
> procstat,name="dnsmasq",pid="44979" cpu_user=0.14,cpu_system=0.07 > procstat,pidfile=/var/run/lxc/dnsmasq.pid,process_name=dnsmasq,pid=44979 cpu_user=0.14,cpu_system=0.07
> procstat,name="influxd",pid="34337" influxd_cpu_user=25.43,influxd_cpu_system=21.82 > procstat,exe=influxd,process_name=influxd,pid=34337 influxd_cpu_user=25.43,influxd_cpu_system=21.82
``` ```
# Measurements # Measurements