Project: Netdata (Observability and Analysis / Observability)
File: dell_emc_scaleio.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/scaleio/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/scaleio/metadata.yaml" sidebar_label: "Dell EMC ScaleIO" learn_status: "Published" learnrelpath: "Collecting Metrics/Storage, Mount Points and Filesystems" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/dell.svg" width="150"/> Plugin: go.d.plugin Module: scaleio <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | scaleio.systemcapacitytotal | total | KiB | | scaleio.systemcapacityinuse | inuse | KiB | | scaleio.systemcapacityusage | thick, decreased, thin, snapshot, spare, unused | KiB | | scaleio.systemcapacityavailablevolumeallocation | available | KiB | | scaleio.systemcapacityhealthstate | protected, degraded, inmaintenance, failed, unavailable | KiB | | scaleio.systemworkloadprimarybandwidthtotal | total | KiB/s | | scaleio.systemworkloadprimary_bandwidth | read, write | KiB/s | | scaleio.systemworkloadprimaryiopstotal | total | iops/s | | scaleio.systemworkloadprimary_iops | read, write | iops/s | | scaleio.systemworkloadprimaryiosizetotal | iosize | KiB | | scaleio.system_rebalance | read, write | KiB/s | | scaleio.systemrebalanceleft | left | KiB | | scaleio.systemrebalancetimeuntilfinish | time | seconds | | scaleio.system_rebuild | read, write | KiB/s | | scaleio.systemrebuildleft | left | KiB | | scaleio.systemdefinedcomponents | devices, faultsets, protectiondomains, rfcachedevices, sdc, sds, snapshots, storagepools, volumes, vtrees | components | | scaleio.systemcomponentsvolumesbytype | thick, thin | volumes | | scaleio.systemcomponentsvolumesbymapping | mapped, unmapped | volumes | These metrics refer to the storage pool. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | scaleio.storagepoolcapacity_total | total | KiB | | scaleio.storagepoolcapacityinuse | in_use | KiB | | scaleio.storagepoolcapacity_usage | thick, decreased, thin, snapshot, spare, unused | KiB | | scaleio.storagepoolcapacity_utilization | used | percentage | | scaleio.storagepoolcapacityavailablevolume_allocation | available | KiB | | scaleio.storagepoolcapacityhealthstate | protected, degraded, in_maintenance, failed, unavailable | KiB | | scaleio.storagepoolcomponents | devices, snapshots, volumes, vtrees | components | These metrics refer to the SDC (ScaleIO Data Client). This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | scaleio.sdcmdmconnection_state | connected | boolean | | scaleio.sdc_bandwidth | read, write | KiB/s | |

| read, write | iops/s | | scaleio.sdciosize | read, write | KiB | | scaleio.sdcnumofmappedvolumed | mapped | volumes | There are no alerts configured by default for this integration. No action required. The configuration file name for this integration is `go.d/scaleio.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/scaleio.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | 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 | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | 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 | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local url: https://127.0.0.1 username: admin password: password tlsskipverify: yes # self-signed certificate ``` </details> Note: When you define multiple jobs, their names must be unique. Local and remote instance. <details><summary>Config</summary> ```yaml jobs: name: local url: https://127.0.0.1 username: admin password: password tlsskipverify: yes # self-signed certificate name: remote url: https://203.0.113.10 username: admin password: password tlsskipverify: yes ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m scaleio ```