This plugin collects metrics from psutil which gathers information on running processes and system utilization (CPU, memory, disks, network).
It's used in the Snap framework.
- golang 1.6+ (needed only for building)
Note: This plugin does not require Python rather it depends on the go library gopsutil.
All OSs currently supported by snap:
- Linux/amd64
- Darwin/amd64
You can get the pre-built binaries for your OS and architecture under the plugin's release page. For Snap, check here.
Fork https://github.com/intelsdi-x/snap-plugin-collector-psutil
Clone repo into $GOPATH/src/github.com/intelsdi-x/:
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-psutil.git
Build the plugin by running make within the cloned repo:
$ make
This builds the plugin in ./build/
- Set up the Snap framework
Some metrics are platform specific (see gopsutil's current status).
Available configuration option:
- mount_points - configuration of mount points to monitor, multiple paths should be separated with "|", e.g. "/|/dev|/run", default is set to collect only physical devices (hard disks, cd-rom, USB). Passing
*enables collect data from all mount points.
There are a number of other resources you can review to learn to use this plugin:
- gopsutil (go based implementation)
- psutil (python based implementation)
- Snap psutil integration test
- Snap psutil unit test
- Snap psutil examples
This plugin has the ability to gather the following metrics:
| Namespace | Description (optional) |
|---|---|
| /intel/psutil/cpu/cpu-total/guest | time spent in guest mode accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/guest_nice | time spent running a niced guest (virtual CPU for guest operating systems under the control of the Linux kernel) accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/idle | time spent in the idle task accumulated over all cpus. This value should be USER_HZ times the second entry in the /proc/uptime pseudo-file |
| /intel/psutil/cpu/cpu-total/iowait | time waiting for I/O to complete accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/irq | time servicing interrupts accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/nice | time spent in user mode with low priority (nice) accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/softirq | time spent servicing softirqs accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/steal | stolen time, which is the time spent in other operating systems when running in a virtualized environment accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/stolen | |
| /intel/psutil/cpu/cpu-total/system | time spent in system mode accumulated over all cpus |
| /intel/psutil/cpu/cpu-total/user | time spent in user mode accumulated over all cpus |
| /intel/psutil/cpu/[CPU]/guest | time spent in guest mode |
| /intel/psutil/cpu/[CPU]/guest_nice | time spent running a niced guest (virtual CPU for guest operating systems under the control of the Linux kernel) |
| /intel/psutil/cpu/[CPU]/idle | time spent in the idle task. This value should be USER_HZ times the second entry in the /proc/uptime pseudo-file |
| /intel/psutil/cpu/[CPU]/iowait | time waiting for I/O to complete |
| /intel/psutil/cpu/[CPU]/irq | time servicing interrupts |
| /intel/psutil/cpu/[CPU]/nice | time spent in user mode with low priority (nice) |
| /intel/psutil/cpu/[CPU]/softirq | time spent servicing softirqs |
| /intel/psutil/cpu/[CPU]/steal | stolen time, which is the time spent in other operating systems when running in a virtualized environment |
| /intel/psutil/cpu/[CPU]/stolen | |
| /intel/psutil/cpu/[CPU]/system | time spent in system mode |
| /intel/psutil/cpu/[CPU]/user | time spent in user mode |
| /intel/psutil/disk/[mount_point]/total | total space which is available to root in mount point |
| /intel/psutil/disk/[mount_point]/used | total space being used in general in mount point |
| /intel/psutil/disk/[mount_point]/free | remaining free space usable by user mount point |
| /intel/psutil/disk/[mount_point]/percent | user usage percent compared to the total amount of space the user can use in mount point |
| /intel/psutil/load/load1 | load average over the last 1 minute |
| /intel/psutil/load/load15 | load average over the last 15 minutes |
| /intel/psutil/load/load5 | load average over the last 5 minutes |
| /intel/psutil/net/all/bytes_recv | number of bytes sent |
| /intel/psutil/net/all/bytes_sent | number of bytes received |
| /intel/psutil/net/all/dropin | total number of incoming packets which were dropped |
| /intel/psutil/net/all/dropout | total number of outgoing packets which were dropped (always 0 on OSX and BSD) |
| /intel/psutil/net/all/errin | total number of errors while receiving |
| /intel/psutil/net/all/errout | total number of errors while sending |
| /intel/psutil/net/all/packets_recv | number of packets received |
| /intel/psutil/net/all/packets_sent | number of packets sent |
| /intel/psutil/net/[INTERFACE]/bytes_recv | number of bytes sent on given interface |
| /intel/psutil/net/[INTERFACE]/bytes_sent | number of bytes received on given interface |
| /intel/psutil/net/[INTERFACE]/dropin | total number of incoming packets which were dropped on given interface |
| /intel/psutil/net/[INTERFACE]/dropout | total number of outgoing packets which were dropped (always 0 on OSX and BSD) o given interface |
| /intel/psutil/net/[INTERFACE]/errin | total number of errors while receiving on given interface |
| /intel/psutil/net/[INTERFACE]/errout | total number of errors while sending on given interface |
| /intel/psutil/net/[INTERFACE]/packets_recv | number of packets received on given interface |
| /intel/psutil/net/[INTERFACE]/packets_sent | number of packets sent on given interface |
| /intel/psutil/vm/active | memory currently in use or very recently used, and so it is in RAM |
| /intel/psutil/vm/available | the actual amount of available memory that can be given instantly to processes that request more memory in bytes; this is calculated by summing different memory values depending on the platform (e.g. free + buffers + cached on Linux) and it is supposed to be used to monitor actual memory usage in a cross platform fashion |
| /intel/psutil/vm/buffers | cache for things like file system metadata |
| /intel/psutil/vm/cached | cache for various things |
| /intel/psutil/vm/free | memory not being used at all (zeroed) that is readily available; note that this doesn't reflect the actual memory available (use 'available' instead). |
| /intel/psutil/vm/inactive | memory that is marked as not used |
| /intel/psutil/vm/total | total physical memory available |
| /intel/psutil/vm/used | memory used, calculated differently depending on the platform and designed for informational purposes only. |
| /intel/psutil/vm/used_percent | percent memory used |
| /intel/psutil/vm/wired | memory that is marked to always stay in RAM. It is never moved to disk |
*Please note that there is no possibility to request specific instance of dynamic disk metric passing it via requested metric in task manifest. I collect metrics based on configured mount points All collected network counters contains information about the hardware address (tag -> hardware_address) and the MTU (tag -> mtu).
This is an example running psutil and writing data to a file. It is assumed that you are using the latest Snap binary and plugins.
The example is run from a directory which includes snaptel, snapteld, along with the plugins and task file.
In one terminal window, open the Snap daemon (in this case with logging set to 1 and trust disabled):
$ snapteld -l 1 -t 0
In another terminal window: Load psutil plugin
$ snaptel plugin load snap-plugin-collector-psutil
See available metrics for your system
$ snaptel metric list
Create a task manifest file (e.g. task-psutil.json):
{
"version": 1,
"schedule": {
"type": "simple",
"interval": "1s"
},
"workflow": {
"collect": {
"metrics": {
"/intel/psutil/load/load1": {},
"/intel/psutil/load/load5": {},
"/intel/psutil/load/load15": {},
"/intel/psutil/cpu/*/user": {},
"/intel/psutil/net/*/bytes_sent": {},
"/intel/psutil/vm/available": {},
"/intel/psutil/vm/free": {},
"/intel/psutil/vm/used": {}
},
"config": {
"/intel/mock": {
"password": "secret",
"user": "root"
}
},
"publish": [
{
"plugin_name": "file",
"config": {
"file": "/tmp/published_psutil"
}
}
]
}
}
}Load file plugin for publishing:
$ snaptel plugin load snap-plugin-publisher-file
Plugin loaded
Name: file
Version: 3
Type: publisher
Signed: false
Loaded Time: Fri, 20 Nov 2015 11:41:39 PST
Create task:
$ snaptel task create -t task-psutil.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running
See file output (this is just part of the file):
2015-11-20 11:46:03.637390565 -0800 PST|[intel psutil load load1]|1.82|username-mac01.jf.intel.com
2015-11-20 11:46:03.641160359 -0800 PST|[intel psutil load load15]|2.09|username-mac01.jf.intel.com
2015-11-20 11:46:03.643858208 -0800 PST|[intel psutil load load5]|2.08|username-mac01.jf.intel.com
2015-11-20 11:46:03.661173851 -0800 PST|[intel psutil vm available]|168882176|username-mac01.jf.intel.com
2015-11-20 11:46:03.67167664 -0800 PST|[intel psutil vm free]|168943616|username-mac01.jf.intel.com
2015-11-20 11:46:03.681965105 -0800 PST|[intel psutil vm used]|17010798592|username-mac01.jf.intel.com
2015-11-20 11:46:04.641244629 -0800 PST|[intel psutil load load1]|1.82|username-mac01.jf.intel.com
2015-11-20 11:46:04.644420189 -0800 PST|[intel psutil load load15]|2.09|username-mac01.jf.intel.com
2015-11-20 11:46:04.647166418 -0800 PST|[intel psutil load load5]|2.08|username-mac01.jf.intel.com
2015-11-20 11:46:04.657065347 -0800 PST|[intel psutil vm available]|168984576|username-mac01.jf.intel.com
2015-11-20 11:46:04.666346721 -0800 PST|[intel psutil vm free]|169054208|username-mac01.jf.intel.com
2015-11-20 11:46:04.676683476 -0800 PST|[intel psutil vm used]|17010716672|username-mac01.jf.intel.com
Stop task:
$ snaptel task stop 02dd7ff4-8106-47e9-8b86-70067cd0a850
Task stopped:
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue and/or submit a pull request.
This repository is one of many plugins in Snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap To reach out to other users, head to the main framework
We love contributions!
There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.
Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.
- Author: @jcooklin
And thank you! Your contribution, through code and participation, is incredibly important to us.