scaleio

README

ScaleIO monitoring with Netdata

Dell EMC ScaleIO is a software-defined storage product from Dell EMC that creates a server-based storage area network from local application server storage using existing customer hardware or EMC servers.

This module monitors one or more ScaleIO (VxFlex OS) instances via VxFlex OS Gateway API.

It collects metrics for following ScaleIO components:

• System
• Storage Pool
• Sdc

ScaleIO module is tested on:

• VxFlex OS v2.6.1.1_113, REST API v2.5
• VxFlex OS v3.0.0.1_134, REST API v3.0

Charts

It produces the following charts:

System

• Total Capacity in KiB
• Capacity In Use in KiB
• Capacity Usage in KiB
• Available For Volume Allocation in KiB
• Capacity Health State in KiB
• Primary Backend Bandwidth Total (Read and Write) in KiB/s
• Primary Backend Bandwidth in KiB/s
• Primary Backend IOPS Total (Read and Write) in iops/s
• Primary Backend IOPS in iops/s
• Primary Backend I/O Size Total (Read and Write) in KiB
• Rebalance in KiB/s
• Rebalance Pending Capacity in KiB
• Rebalance Approximate Time Until Finish in seconds
• Rebuild Bandwidth Total (Forward, Backward and Normal) in KiB/s
• Rebuild Pending Capacity Total (Forward, Backward and Normal) in KiB
• Components in number
• Volumes By Type in number
• Volumes By Mapping in number

Storage Pool

• Total Capacity in KiB
• Capacity In Use in KiB
• Capacity Usage in KiB
• Capacity Utilization in percentage
• Available For Volume Allocation in KiB
• Capacity Health State in KiB
• Components in number

SDC

• MDM Connection State in boolean
• Bandwidth in KiB/s
• IOPS in iops/s
• I/O Size in KiB
• Mapped Volumes in volumes

Configuration

Edit the go.d/scaleio.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/scaleio.conf

Needs only url of VxFlex OS Gateway API, MDM username and password. Here is an example for 2 instances:

jobs:
  - name: local
    url: https://127.0.0.1
    username: admin
    password: password
    tls_skip_verify: yes  # self-signed certificate

  - name: remote
    url: https://203.0.113.10
    username: admin
    password: password

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the scaleio collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

./go.d.plugin -d -m scaleio

Documentation

Index

• type Charts
• type Config
• type Dims
• type ScaleIO
  • func New() *ScaleIO
  • func (s *ScaleIO) Charts() *module.Charts
  • func (s *ScaleIO) Check() bool
  • func (s *ScaleIO) Cleanup()
  • func (s *ScaleIO) Collect() map[string]int64
  • func (s *ScaleIO) Init() bool
• type Vars

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts.

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

Config is the ScaleIO module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims.

type ScaleIO

type ScaleIO struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

ScaleIO ScaleIO module.

func New

func New() *ScaleIO

New creates ScaleIO with default values.

func (*ScaleIO) Charts

func (s *ScaleIO) Charts() *module.Charts

Charts returns Charts.

func (*ScaleIO) Check

func (s *ScaleIO) Check() bool

Check makes check.

func (*ScaleIO) Cleanup

func (s *ScaleIO) Cleanup()

Cleanup makes cleanup.

func (*ScaleIO) Collect

func (s *ScaleIO) Collect() map[string]int64

Collect collects metrics.

func (*ScaleIO) Init

func (s *ScaleIO) Init() bool

Init makes initialization.

type Vars

type Vars = module.Vars

Vars is an alias for module.Vars.