snap collector plugin - ethtool

This plugin uses ethtool to gather interface statistics. Current version exposes stats available using ethtool -S command.

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. You don't have to perform any configuration or installation steps.

System Requirements

• ethtool available under $PATH or /sbin/
• golang 1.4+

Operating systems

All OSs currently supported by plugin:

• Linux/amd64

Installation

Download ethtool plugin binary:

You can get the pre-built binaries for your OS and architecture at snap's GitHub Releases page.

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 plugin by running make within the cloned repo:

$ make

This builds the plugin in /build/rootfs/

Configuration and Usage

• Set up the snap framework
• Ensure $SNAP_PATH is exported
  export SNAP_PATH=$GOPATH/src/github.com/intelsdi-x/snap/build

####Tips: -Adding more metrics to monitor per NIC is very cheap in terms of CPU time.

Documentation

You can learn about some of exposed metrics here

Collected Metrics

List of metrics for each device is dependent on it's driver. Metrics are available in namespace /intel/net/<device name>/<metric name> and all are int's.

Roadmap

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

• Metrics from device's registry dump when using IXGBE driver.

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

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](https://github.com/intelsdi-x/snap#community-support.

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.

License

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

Acknowledgements

• Author: Lukasz Mroz

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