Collects ScaleIO performance metrics
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
examples
scaleio
scripts
.gitignore
.pluginsync.yml
.sync.yml
.travis.yml
CONTRIBUTING.md
LICENSE
METRICS.md
Makefile
README.md
glide.lock
glide.yaml
main.go
main_small_test.go

README.md

Build Status

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

This plugin supports collecting metrics from a ScaleIO cluster

It's used in the Snap framework.

  1. Getting Started
  2. Documentation
  3. Roadmap
  4. Community Support
  5. Contributing
  6. License
  7. Acknowledgements

Getting Started

System Requirements

Installation

Download File plugin binary:

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

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/

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

List of metrics collected by this plugin can be found in METRICS.md file.

All metrics are exposed with a dynamic namespace that encompasses each StoragePool. You can collect metrics from all of them or specify a storage pool that you are interested by putting its name instead wildcard - see how to specify the instance of dynamic metric in Snap framework documentation.

Examples

There is an example config found in the examples directory.

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

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