2015-10-05 22:45:40 +00:00
|
|
|
# Telegraf plugin: procstat
|
|
|
|
|
|
|
|
|
|
#### Description
|
2015-10-05 20:24:06 +00:00
|
|
|
|
|
|
|
|
The procstat plugin can be used to monitor system resource usage by an
|
2015-10-05 22:45:40 +00:00
|
|
|
individual process using their /proc data.
|
2015-10-05 20:24:06 +00:00
|
|
|
|
2016-02-19 18:27:47 +00:00
|
|
|
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
|
2015-10-05 22:45:40 +00:00
|
|
|
plugin will use `pgrep` when executable name is provided to obtain the pid.
|
2016-10-25 12:57:55 +00:00
|
|
|
Procstat plugin will transmit IO, memory, cpu, file descriptor related
|
2015-10-05 22:45:40 +00:00
|
|
|
measurements for every process specified. A prefix can be set to isolate
|
|
|
|
|
individual process specific measurements.
|
2015-10-05 20:24:06 +00:00
|
|
|
|
2017-04-24 18:18:55 +00:00
|
|
|
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
|
|
|
|
|
|
2015-10-05 20:24:06 +00:00
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
```
|
2016-01-15 22:55:41 +00:00
|
|
|
[[inputs.procstat]]
|
|
|
|
|
exe = "influxd"
|
|
|
|
|
prefix = "influxd"
|
2015-10-07 18:31:49 +00:00
|
|
|
|
2016-01-15 22:55:41 +00:00
|
|
|
[[inputs.procstat]]
|
|
|
|
|
pid_file = "/var/run/lxc/dnsmasq.pid"
|
2015-10-07 18:31:49 +00:00
|
|
|
```
|
2015-10-05 20:24:06 +00:00
|
|
|
|
2015-10-07 18:31:49 +00:00
|
|
|
The above configuration would result in output like:
|
|
|
|
|
|
|
|
|
|
```
|
2017-04-24 18:18:55 +00:00
|
|
|
> procstat,pidfile=/var/run/lxc/dnsmasq.pid,process_name=dnsmasq,pid=44979 cpu_user=0.14,cpu_system=0.07
|
|
|
|
|
> procstat,exe=influxd,process_name=influxd,pid=34337 influxd_cpu_user=25.43,influxd_cpu_system=21.82
|
2015-10-05 20:24:06 +00:00
|
|
|
```
|
2015-10-05 22:45:40 +00:00
|
|
|
|
|
|
|
|
# Measurements
|
2015-10-07 18:31:49 +00:00
|
|
|
Note: prefix can be set by the user, per process.
|
2015-10-05 22:45:40 +00:00
|
|
|
|
2016-03-06 06:42:14 +00:00
|
|
|
|
|
|
|
|
Threads related measurement names:
|
|
|
|
|
- procstat_[prefix_]num_threads value=5
|
|
|
|
|
|
2017-05-25 20:06:27 +00:00
|
|
|
File descriptor related measurement names (*telegraf* needs to run as **root**):
|
2015-10-07 18:31:49 +00:00
|
|
|
- procstat_[prefix_]num_fds value=4
|
2015-10-05 22:45:40 +00:00
|
|
|
|
|
|
|
|
Context switch related measurement names:
|
2015-10-07 18:31:49 +00:00
|
|
|
- procstat_[prefix_]voluntary_context_switches value=250
|
|
|
|
|
- procstat_[prefix_]involuntary_context_switches value=0
|
2015-10-05 22:45:40 +00:00
|
|
|
|
2017-05-25 20:06:27 +00:00
|
|
|
I/O related measurement names (*telegraf* needs to run as **root**):
|
2015-10-07 18:31:49 +00:00
|
|
|
- procstat_[prefix_]read_count value=396
|
|
|
|
|
- procstat_[prefix_]write_count value=1
|
|
|
|
|
- procstat_[prefix_]read_bytes value=1019904
|
|
|
|
|
- procstat_[prefix_]write_bytes value=1
|
2015-10-05 22:45:40 +00:00
|
|
|
|
|
|
|
|
CPU related measurement names:
|
2015-10-07 18:31:49 +00:00
|
|
|
- procstat_[prefix_]cpu_user value=0
|
|
|
|
|
- procstat_[prefix_]cpu_system value=0.01
|
|
|
|
|
- procstat_[prefix_]cpu_idle value=0
|
|
|
|
|
- procstat_[prefix_]cpu_nice value=0
|
|
|
|
|
- procstat_[prefix_]cpu_iowait value=0
|
|
|
|
|
- procstat_[prefix_]cpu_irq value=0
|
|
|
|
|
- procstat_[prefix_]cpu_soft_irq value=0
|
|
|
|
|
- procstat_[prefix_]cpu_soft_steal value=0
|
|
|
|
|
- procstat_[prefix_]cpu_soft_stolen value=0
|
|
|
|
|
- procstat_[prefix_]cpu_soft_guest value=0
|
|
|
|
|
- procstat_[prefix_]cpu_soft_guest_nice value=0
|
2015-10-05 22:45:40 +00:00
|
|
|
|
|
|
|
|
Memory related measurement names:
|
2015-10-07 18:31:49 +00:00
|
|
|
- procstat_[prefix_]memory_rss value=1777664
|
|
|
|
|
- procstat_[prefix_]memory_vms value=24227840
|
|
|
|
|
- procstat_[prefix_]memory_swap value=282624
|
