Collects Linux SCSI statistics
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/tasks
scripts
scsi
.gitignore
.pluginsync.yml
.sync.yml
.travis.yml
CONTRIBUTING.md
LICENSE
METRICS.md
Makefile
README.md
glide.lock
glide.yaml
main.go
main_test.go

README.md

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.

Build Status Go Report Card

Snap collector plugin - scsi

This plugin collects metrics from scsi.

It's used in the Snap framework.

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

Getting Started

Plugin collects specified metrics from linux scsi

System Requirements

  • golang 1.7+ - needed only for building
  • This Plugin compatible with kernel > 2.6
  • Linux/x86_64

Operating systems

All OSs currently supported by snap:

  • Linux/amd64

Installation

Download use 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-scsi

Clone repo into $GOPATH/src/github/intelsdi-x/:

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

Build the plugin by running make in repo:

$ make

This builds the plugin in /build/

Configuration and Usage

Documentation

Collected Metrics

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

Examples

Example of running Snap scsi 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-scsi/latest/linux/x86_64/snap-plugin-collector-scsi
$ 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-scsi
$ snaptel plugin load snap-plugin-publisher-file

Create a task manifest file  (exemplary files in [examples/tasks/] (examples/tasks/)):
```yaml
---
  version: 1
  schedule:
    type: "simple"
    interval: "1s"
  max-failures: 10
  workflow:
    collect:
      metrics:
         /intel/scsi/*/iodone_cnt: {}
         /intel/scsi/*/ioerr_cnt: {}
         /intel/scsi/*/iorequest_cnt: {}
      publish:
        - plugin_name: "file"
          config:
            file: "/tmp/scsi_metrics"

Download an example task file and load it:

$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-scsi/master/examples/tasks/scsi-file.yaml
$ snaptel task create -t scsi-file.yaml
Using task manifest to create task
Task created
ID: 250323af-12b0-4bf8-a526-eb2ca7d8ae32
Name: Task-250323af-12b0-4bf8-a526-eb2ca7d8ae32
State: Running

See realtime output from snaptel task watch <task_id> (CTRL+C to exit)

$ snaptel task watch 250323af-12b0-4bf8-a526-eb2ca7d8ae32

This data is published to a file /tmp/scsi_metrics per task specification

Stop task:

$ snaptel task stop 250323af-12b0-4bf8-a526-eb2ca7d8ae32
Task stopped:
ID: 250323af-12b0-4bf8-a526-eb2ca7d8ae32

Roadmap

As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue.

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

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

This is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.

This software has been contributed by MIKELANGELO & Superfluidity, Horizon 2020 projects co-funded by the European Union. https://www.mikelangelo-project.eu/ http://superfluidity.eu/

Thank You

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