DISCONTINUATION OF PROJECT.
This project will no longer be maintained by Intel.
This project has been identified as having known security escapes.
Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.
Intel no longer accepts patches to this project.
This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.
This plugin supports collecting utilization, saturation and error metrics from GNU/Linux OS.
- golang 1.7+ - needed only for building
- This Plugin compatible with kernel > 2.6
- Linux/x86_64
- Linux/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-use
Clone repo into $GOPATH/src/github.com/intelsdi-x/:
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-use.git
Build the snap use plugin by running make within the cloned repo:
$ make
This builds the plugin in ./build/
Set up the snap framework.
Load the plugin and create a task, see example in Examples.
The Utilization Saturation and Errors (USE) Method is a methodology for analyzing the performance of any system. It directs the construction of a checklist, which for server analysis can be used for quickly identifying resource bottlenecks or errors. It begins by posing questions, and then seeks answers, instead of beginning with given metrics (partial answers) and trying to work backwards (1). Brendan D. Gregg is an author of USE methodology.
List of collected metrics is described in METRICS.md.
Example of running snap use collector and writing data to file.
Ensure snap daemon is running:
- initd:
service snap-telemetry start - systemd:
systemctl start snap-telemetry - command line:
snapteld -l 1 -t 0 &
Download and load snap plugins:
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-use/latest/linux/x86_64/snap-plugin-collector-use
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ chmod 755 snap-plugin-*
$ snaptel plugin load snap-plugin-collector-use
$ snaptel plugin load snap-plugin-publisher-file
Create a task manifest file (exemplary files in [examples/tasks/] (examples/tasks/)):
---
schedule:
interval: 1s
type: simple
version: 1
workflow:
collect:
metrics:
/intel/use/compute/saturation: {}
/intel/use/compute/utilization: {}
/intel/use/memory/saturation: {}
/intel/use/memory/utilization: {}
/intel/use/network/eth0/saturation: {}
/intel/use/network/eth0/utilization: {}
/intel/use/storage/sda/saturation: {}
/intel/use/storage/sda/utilization: {}
publish:
-
plugin_name: file
config:
file: /tmp/use_metrics
Download an example task file and load it:
$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-use/master/examples/tasks/use-file.yml
$ snaptel task create -t use-file.yml
Using task manifest to create task
Task created
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
Name: Task-480323af-15b0-4af8-a526-eb2ca6d8ae67
State: Running
See realtime output from snaptel task watch <task_id> (CTRL+C to exit)
$ snaptel task watch 480323af-15b0-4af8-a526-eb2ca6d8ae67
This data is published to a file /tmp/use_metrics per task specification
Stop task:
$ snaptel task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
Task stopped:
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
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 or visit Slack.
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.
This is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.
- Author: Marcin Spoczynski
And thank you! Your contribution, through code and participation, is incredibly important to us.
(1) http://www.brendangregg.com/usemethod.html
This software has been contributed by MIKELANGELO, a Horizon 2020 project co-funded by the European Union. https://www.mikelangelo-project.eu/
And thank you! Your contribution, through code and participation, is incredibly important to us.