Dell EMC ScaleIO

Plugin: go.d.plugin Module: scaleio

Overview

This collector monitors ScaleIO (VxFlex OS) instances via VxFlex OS Gateway API.

It collects metrics for the following ScaleIO components:

• System
• Storage Pool
• Sdc

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Dell EMC ScaleIO instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
scaleio.system_capacity_total	total	KiB
scaleio.system_capacity_in_use	in_use	KiB
scaleio.system_capacity_usage	thick, decreased, thin, snapshot, spare, unused	KiB
scaleio.system_capacity_available_volume_allocation	available	KiB
scaleio.system_capacity_health_state	protected, degraded, in_maintenance, failed, unavailable	KiB
scaleio.system_workload_primary_bandwidth_total	total	KiB/s
scaleio.system_workload_primary_bandwidth	read, write	KiB/s
scaleio.system_workload_primary_iops_total	total	iops/s
scaleio.system_workload_primary_iops	read, write	iops/s
scaleio.system_workload_primary_io_size_total	io_size	KiB
scaleio.system_rebalance	read, write	KiB/s
scaleio.system_rebalance_left	left	KiB
scaleio.system_rebalance_time_until_finish	time	seconds
scaleio.system_rebuild	read, write	KiB/s
scaleio.system_rebuild_left	left	KiB
scaleio.system_defined_components	devices, fault_sets, protection_domains, rfcache_devices, sdc, sds, snapshots, storage_pools, volumes, vtrees	components
scaleio.system_components_volumes_by_type	thick, thin	volumes
scaleio.system_components_volumes_by_mapping	mapped, unmapped	volumes

Per storage pool

These metrics refer to the storage pool.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
scaleio.storage_pool_capacity_total	total	KiB
scaleio.storage_pool_capacity_in_use	in_use	KiB
scaleio.storage_pool_capacity_usage	thick, decreased, thin, snapshot, spare, unused	KiB
scaleio.storage_pool_capacity_utilization	used	percentage
scaleio.storage_pool_capacity_available_volume_allocation	available	KiB
scaleio.storage_pool_capacity_health_state	protected, degraded, in_maintenance, failed, unavailable	KiB
scaleio.storage_pool_components	devices, snapshots, volumes, vtrees	components

Per sdc

These metrics refer to the SDC (ScaleIO Data Client).

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
scaleio.sdc_mdm_connection_state	connected	boolean
scaleio.sdc_bandwidth	read, write	KiB/s
scaleio.sdc_iops	read, write	iops/s
scaleio.sdc_io_size	read, write	KiB
scaleio.sdc_num_of_mapped_volumed	mapped	volumes

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/scaleio.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name1

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/scaleio.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options

Name	Description	Default	Required
update_every	Data collection frequency.	5	no
autodetection_retry	Recheck interval in seconds. Zero means no recheck will be scheduled.	0	no
url	Server URL.	https://127.0.0.1:80	yes
timeout	HTTP request timeout.	1	no
username	Username for basic HTTP authentication.		yes
password	Password for basic HTTP authentication.		yes
proxy_url	Proxy URL.		no
proxy_username	Username for proxy basic HTTP authentication.		no
proxy_password	Password for proxy basic HTTP authentication.		no
method	HTTP request method.	GET	no
body	HTTP request body.		no
headers	HTTP request headers.		no
not_follow_redirects	Redirect handling policy. Controls whether the client follows redirects.	no	no
tls_skip_verify	Server certificate chain and hostname validation policy. Controls whether the client performs this check.	no	no
tls_ca	Certification authority that the client uses when verifying the server's certificates.		no
tls_cert	Client TLS certificate.		no
tls_key	Client TLS key.		no

Examples

Basic

An example configuration.

Config

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

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instance.

Config

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
    tls_skip_verify: yes

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the go.d.plugin to debug the collector:

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

Getting Logs

If you're encountering problems with the scaleio collector, follow these steps to retrieve logs and identify potential issues:

• Run the command specific to your system (systemd, non-systemd, or Docker container).
• Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep scaleio

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep scaleio /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep scaleio