DISCONTINUATION OF 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.
Snap collector plugin - interface
This plugin collects metrics from /proc/interface kernel interface about the traffic (octets per second), packets per second and errors of interfaces.
It's used in the Snap framework.
All OSs currently supported by Snap:
Download the plugin binary:
You can get the pre-built binaries for your OS and architecture from the plugin's GitHub Releases page. Download the plugin from the latest release and load it into
/opt/snap/plugins is the default location for Snap packages).
To build the plugin binary:
Clone repo into
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-interface.git
Build the Snap interface plugin by running make within the cloned repo:
This builds the plugin in
Configuration and Usage
proc_pathpath to '1/net/dev' file (helpful for running plugin in Docker container) In fact this file should NOT be <proc_path>/net/dev because this is a symlink and therefore will resolve in the exact same way both within or outside of a container. Therefore PID 1 has to be used
List of collected metrics is described in METRICS.md.
Plugin reads metrics from
<proc_path>/1/net/dev file. (see comment above)
Path to above file can be provided in configuration in task manifest as
proc_path. If configuration is not provided, plugin will try
to read from default location which is
Example of running Snap interface collector and writing data to file.
Ensure Snap daemon is running:
service snap-telemetry start
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-interface/latest/linux/x86_64/snap-plugin-collector-interface $ 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-interface $ snaptel plugin load snap-plugin-publisher-file
See all available metrics:
$ snaptel metric list
Download an example task file and load it:
$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-interface/master/examples/tasks/iface-file.json $ snaptel task create -t iface-file.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 realtime output from
snaptel task watch <task_id> (CTRL+C to exit)
This data is published to a file
/tmp/published_interface per task specification
$ 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 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.
- Author: Marcin Krolik