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.

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples
• Roadmap

3. Community Support
4. Contributing
5. License
6. 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

You can get the pre-built binaries for your OS and architecture at snap's GitHub Releases page. Download the plugins package from the latest release, unzip and store in a path you want snapd to access.

Then, get started with the snap framework.

To build the plugin binary yourself:

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

Ensure $SNAP_PATH is exported in order to build locally:

export SNAP_PATH=$GOPATH/src/github.com/intelsdi-x/snap/build

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in /build/rootfs/

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):

• for driver E1000E
• for driver IXGBE
• for driver FM10K
• for driver TG3

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)

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:

• Snap Gitter channel

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