thomastaylor312 / snap-plugin-collector-scaleio

A Snap collector plugin for ScaleIO

snap collector plugin - ScaleIO

This plugin supports collecting metrics from a ScaleIO cluster

It's used in the Snap framework.

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples

3. Roadmap
4. Community Support
5. Contributing
6. License
7. Acknowledgements

Getting Started

System Requirements

• golang 1.5+ (needed only for building)

Installation

Download File plugin binary:

You can get the pre-built binaries for your OS and architecture at the GitHub Releases page of this repository.

To build the plugin binary:

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

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

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in ./build/rootfs/

Configuration and Usage

First, be sure that you've familiarized yourself with the Snap framework by reading the Getting Started documentation.

This plugin requires several config options to run properly:

Required

• gateway: This is the URL of the gateway server.
• username and password: A username and password with the appropriate access to the REST API

Optional

• verifySSL: If set to false this disables SSL validation. This should not be used in production.

A full config example is below:

"/intel/scaleio": {
    "username": "admin",
    "password": "password",
    "gateway": "https://my-cluster",
    "verifySSL": false
}

Documentation

Collected Metrics

Currently, all metrics are exposed with a dynamic namespace that encompasses each StoragePool. This means that it will collect the data for all storage pools. There is an upcoming Snap feature that will allow you to specify a specific storage pool and the documentation will be updated when that feature lands.

There are over 100 metrics exposed for each StoragePool. To prevent you from tiring your finger by scrolling too much, load the plugin into Snap and list the metrics as shown below:

snapctl plugin load snap-plugin-collector-scaleio
snapctl metric list

Examples

There is an example config found in the [examples directory](examples/file-collect.json]

Example watch

NAMESPACE 							 DATA 		 TIMESTAMP
/intel/scaleio/96eb24f700000000/bckRebuildWriteBwc/numOccured 	 0 		 2016-07-08 23:16:02.304238351 -0700 PDT
/intel/scaleio/96eb24f700000000/pendingMovingOutBckRebuildJobs 	 0 		 2016-07-08 23:16:02.304238351 -0700 PDT
/intel/scaleio/96eb24f700000000/snapCapacityInUseInKb 		 3.145728e+06 	 2016-07-08 23:16:02.304238351 -0700 PDT

Roadmap

This is currently in Alpha. Please let us know of any bugs you see.

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 or join the Snap Slack 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.

License

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

Acknowledgements

• Author: Taylor Thomas

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