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.

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 - ethtool

This plugin uses ethtool to gather interface statistics. Current version exposes stats available using ethtool given by below commands:

ethtool -S, interface statistics
ethtool -d, register dump
ethtool -m, digital optical monitoring

It's used in the Snap framework.

Getting Started
Documentation
Community Support
Contributing
License
Acknowledgements

Getting Started

The plugin is ready to use out of the box by following the system requirements. You don't have to perform any configuration or installation steps.

System Requirements

ethtool available under $PATH or /sbin/
golang 1.5+ (needed only for building)
Root privileges are required

Operating systems

All OSs currently supported by plugin:

Linux/amd64

Installation

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 snapteld (/opt/snap/plugins is the default location for Snap packages).

To build the plugin binary:

Fork https://github.com/intelsdi-x/snap-plugin-collector-ethtool Clone repo into $GOPATH/src/github.com/intelsdi-x/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-ethtool.git

Build the Snap ethtool plugin by running make within the cloned repo:

$ make

This builds the plugin in ./build/

Documentation

You can learn about some of the exposed metrics here.

Collected Metrics

This plugin allows to collect interface network statistics such like received|transmitted bytes|packets and more.
List of metrics for each device is dependent on its driver.

This plugin has the ability to gather the following metrics (driver specific):

A few drivers such as IXGBE support exposing optical transceivers (SFP, SFP+, or XFP) information too. The information is known as [digital optical monitoring (DOM)] (METRICS_DOM.md#digital-optical-monitoring) information.

Metrics are available in namespace:

/intel/net/<driver name>/<device name>/nic/<metric name> (from cmd ethtool -S, interface statistics)
/intel/net/<driver name>/<device name>/reg/<metric name> (from cmd ethtool -d, register dump)
/intel/net/<driver name>/<device name>/dom/<metric name> (from cmd ethtool -m, digital optical monitoring)

Examples

Example of running Snap ethtool 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-ethtool/latest/linux/x86_64/snap-plugin-collector-ethtool
$ 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-ethtool
$ 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-ethtool/master/examples/tasks/ethtool-file.json
$ snaptel task create -t ethtool-file.json
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/published_netstats per task specification

Stop task:

$ snaptel task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
Task stopped:
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67

Roadmap

As we launch this plugin, we have a few items in mind for the next release:

[ x ] Metrics from device's registry dump when using IXGBE driver
[ x ] Expose pluggable optics (SFP & SFP+) information

If you have a feature request, please add it as an issue.

Community Support

This repository is one of many plugins in Snap, a powerful telemetry framework. The full project is at http://github.com:intelsdi-x/snap. To reach out on other use cases, visit Slack.

Contributing

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.

And thank you! Your contribution, through code and participation, is incredibly important to us.us.

License

Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

Author: Lukasz Mroz
Co-author: Izabella Raulin

intelsdi-x / snap-plugin-collector-ethtool

readme