Dell EMC ScaleIO icon

Dell EMC ScaleIO

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.

Setup

You can configure the scaleio collector in two ways:

Method Best for How to
UI Fast setup without editing files Go to Nodes → Configure this node → Collectors → Jobs, search for scaleio, then click + to add a job.
File If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) Edit go.d/scaleio.conf and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

No action required.

Configuration

Options

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

Group Option Description Default Required
Collection update_every Data collection interval (seconds). 1 no
autodetection_retry Autodetection retry interval (seconds). Set 0 to disable. 0 no
Target url Target endpoint URL. https://127.0.0.1 yes
timeout HTTP request timeout (seconds). 1 no
HTTP Auth username Username for Basic HTTP authentication. no
password Password for Basic HTTP authentication. no
bearer_token_file Path to a file containing a bearer token (used for Authorization: Bearer). no
TLS tls_skip_verify Skip TLS certificate and hostname verification (insecure). no no
tls_ca Path to CA bundle used to validate the server certificate. no
tls_cert Path to client TLS certificate (for mTLS). no
tls_key Path to client TLS private key (for mTLS). no
Proxy proxy_url HTTP proxy URL. no
proxy_username Username for proxy Basic HTTP authentication. no
proxy_password Password for proxy Basic HTTP authentication. no
Request method HTTP method to use. GET no
body Request body (e.g., for POST/PUT). no
headers Additional HTTP headers (one per line as key: value). no
not_follow_redirects Do not follow HTTP redirects. no no
force_http2 Force HTTP/2 (including h2c over TCP). no no
Virtual Node vnode Associates this data collection job with a Virtual Node. no

via UI

Configure the scaleio collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the scaleio data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type scaleio (or scroll the list) to locate the scaleio collector.
  5. Click the + next to the scaleio collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via 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_name2

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
Examples
Basic

An example configuration.

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.

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

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.

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

    To debug a specific job:

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

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

The observability platform companies need to succeed

Sign up for free

Want a personalised demo of Netdata for your use case?

Book a Demo