| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-scaleio |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: scaleio |
| 7 | monitored_instance: |
| 8 | name: Dell EMC ScaleIO |
| 9 | link: https://www.dell.com/en-ca/dt/storage/scaleio/scaleioreadynode.htm |
| 10 | icon_filename: dell.svg |
| 11 | categories: |
| 12 | - data-collection.storage |
| 13 | keywords: |
| 14 | - scaleio |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector monitors ScaleIO (VxFlex OS) instances via VxFlex OS Gateway API. |
| 24 | |
| 25 | It collects metrics for the following ScaleIO components: |
| 26 | |
| 27 | - System |
| 28 | - Storage Pool |
| 29 | - Sdc |
| 30 | method_description: "" |
| 31 | supported_platforms: |
| 32 | include: [] |
| 33 | exclude: [] |
| 34 | multi_instance: true |
| 35 | additional_permissions: |
| 36 | description: "" |
| 37 | default_behavior: |
| 38 | auto_detection: |
| 39 | description: "" |
| 40 | limits: |
| 41 | description: "" |
| 42 | performance_impact: |
| 43 | description: "" |
| 44 | setup: |
| 45 | prerequisites: |
| 46 | list: [] |
| 47 | configuration: |
| 48 | file: |
| 49 | name: go.d/scaleio.conf |
| 50 | options: |
| 51 | description: | |
| 52 | The following options can be defined globally: update_every, autodetection_retry. |
| 53 | folding: |
| 54 | title: Config options |
| 55 | enabled: true |
| 56 | list: |
| 57 | - name: update_every |
| 58 | description: Data collection interval (seconds). |
| 59 | default_value: 1 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | - name: autodetection_retry |
| 63 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 64 | default_value: 0 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | |
| 68 | - name: url |
| 69 | description: Target endpoint URL. |
| 70 | default_value: https://127.0.0.1 |
| 71 | required: true |
| 72 | group: Target |
| 73 | - name: timeout |
| 74 | description: HTTP request timeout (seconds). |
| 75 | default_value: 1 |
| 76 | required: false |
| 77 | group: Target |
| 78 | |
| 79 | - name: username |
| 80 | description: Username for Basic HTTP authentication. |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: HTTP Auth |
| 84 | - name: password |
| 85 | description: Password for Basic HTTP authentication. |
| 86 | default_value: "" |
| 87 | required: false |
| 88 | group: HTTP Auth |
| 89 | - name: bearer_token_file |
| 90 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 91 | default_value: "" |
| 92 | required: false |
| 93 | group: HTTP Auth |
| 94 | |
| 95 | - name: tls_skip_verify |
| 96 | description: Skip TLS certificate and hostname verification (insecure). |
| 97 | default_value: no |
| 98 | required: false |
| 99 | group: TLS |
| 100 | - name: tls_ca |
| 101 | description: Path to CA bundle used to validate the server certificate. |
| 102 | default_value: "" |
| 103 | required: false |
| 104 | group: TLS |
| 105 | - name: tls_cert |
| 106 | description: Path to client TLS certificate (for mTLS). |
| 107 | default_value: "" |
| 108 | required: false |
| 109 | group: TLS |
| 110 | - name: tls_key |
| 111 | description: Path to client TLS private key (for mTLS). |
| 112 | default_value: "" |
| 113 | required: false |
| 114 | group: TLS |
| 115 | |
| 116 | - name: proxy_url |
| 117 | description: HTTP proxy URL. |
| 118 | default_value: "" |
| 119 | required: false |
| 120 | group: Proxy |
| 121 | - name: proxy_username |
| 122 | description: Username for proxy Basic HTTP authentication. |
| 123 | default_value: "" |
| 124 | required: false |
| 125 | group: Proxy |
| 126 | - name: proxy_password |
| 127 | description: Password for proxy Basic HTTP authentication. |
| 128 | default_value: "" |
| 129 | required: false |
| 130 | group: Proxy |
| 131 | |
| 132 | - name: method |
| 133 | description: HTTP method to use. |
| 134 | default_value: "GET" |
| 135 | required: false |
| 136 | group: Request |
| 137 | - name: body |
| 138 | description: Request body (e.g., for POST/PUT). |
| 139 | default_value: "" |
| 140 | required: false |
| 141 | group: Request |
| 142 | - name: headers |
| 143 | description: "Additional HTTP headers (one per line as key: value)." |
| 144 | default_value: "" |
| 145 | required: false |
| 146 | group: Request |
| 147 | - name: not_follow_redirects |
| 148 | description: Do not follow HTTP redirects. |
| 149 | default_value: no |
| 150 | required: false |
| 151 | group: Request |
| 152 | - name: force_http2 |
| 153 | description: Force HTTP/2 (including h2c over TCP). |
| 154 | default_value: no |
| 155 | required: false |
| 156 | group: Request |
| 157 | |
| 158 | - name: vnode |
| 159 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 160 | default_value: "" |
| 161 | required: false |
| 162 | group: Virtual Node |
| 163 | examples: |
| 164 | folding: |
| 165 | title: Config |
| 166 | enabled: true |
| 167 | list: |
| 168 | - name: Basic |
| 169 | description: An example configuration. |
| 170 | config: | |
| 171 | jobs: |
| 172 | - name: local |
| 173 | url: https://127.0.0.1 |
| 174 | username: admin |
| 175 | password: password |
| 176 | tls_skip_verify: yes # self-signed certificate |
| 177 | - name: Multi-instance |
| 178 | description: | |
| 179 | > **Note**: When you define multiple jobs, their names must be unique. |
| 180 | |
| 181 | Local and remote instance. |
| 182 | config: | |
| 183 | jobs: |
| 184 | - name: local |
| 185 | url: https://127.0.0.1 |
| 186 | username: admin |
| 187 | password: password |
| 188 | tls_skip_verify: yes # self-signed certificate |
| 189 | |
| 190 | - name: remote |
| 191 | url: https://203.0.113.10 |
| 192 | username: admin |
| 193 | password: password |
| 194 | tls_skip_verify: yes |
| 195 | troubleshooting: |
| 196 | problems: |
| 197 | list: [] |
| 198 | alerts: [] |
| 199 | metrics: |
| 200 | folding: |
| 201 | title: Metrics |
| 202 | enabled: false |
| 203 | description: "" |
| 204 | availability: [] |
| 205 | scopes: |
| 206 | - name: global |
| 207 | description: These metrics refer to the entire monitored application. |
| 208 | labels: [] |
| 209 | metrics: |
| 210 | - name: scaleio.system_capacity_total |
| 211 | description: Total Capacity |
| 212 | unit: KiB |
| 213 | chart_type: line |
| 214 | dimensions: |
| 215 | - name: total |
| 216 | - name: scaleio.system_capacity_in_use |
| 217 | description: Capacity In Use |
| 218 | unit: KiB |
| 219 | chart_type: line |
| 220 | dimensions: |
| 221 | - name: in_use |
| 222 | - name: scaleio.system_capacity_usage |
| 223 | description: Capacity Usage |
| 224 | unit: KiB |
| 225 | chart_type: stacked |
| 226 | dimensions: |
| 227 | - name: thick |
| 228 | - name: decreased |
| 229 | - name: thin |
| 230 | - name: snapshot |
| 231 | - name: spare |
| 232 | - name: unused |
| 233 | - name: scaleio.system_capacity_available_volume_allocation |
| 234 | description: Available For Volume Allocation |
| 235 | unit: KiB |
| 236 | chart_type: line |
| 237 | dimensions: |
| 238 | - name: available |
| 239 | - name: scaleio.system_capacity_health_state |
| 240 | description: Capacity Health State |
| 241 | unit: KiB |
| 242 | chart_type: stacked |
| 243 | dimensions: |
| 244 | - name: protected |
| 245 | - name: degraded |
| 246 | - name: in_maintenance |
| 247 | - name: failed |
| 248 | - name: unavailable |
| 249 | - name: scaleio.system_workload_primary_bandwidth_total |
| 250 | description: Primary Backend Bandwidth Total (Read and Write) |
| 251 | unit: KiB/s |
| 252 | chart_type: line |
| 253 | dimensions: |
| 254 | - name: total |
| 255 | - name: scaleio.system_workload_primary_bandwidth |
| 256 | description: Primary Backend Bandwidth |
| 257 | unit: KiB/s |
| 258 | chart_type: area |
| 259 | dimensions: |
| 260 | - name: read |
| 261 | - name: write |
| 262 | - name: scaleio.system_workload_primary_iops_total |
| 263 | description: Primary Backend IOPS Total (Read and Write) |
| 264 | unit: iops/s |
| 265 | chart_type: line |
| 266 | dimensions: |
| 267 | - name: total |
| 268 | - name: scaleio.system_workload_primary_iops |
| 269 | description: Primary Backend IOPS |
| 270 | unit: iops/s |
| 271 | chart_type: area |
| 272 | dimensions: |
| 273 | - name: read |
| 274 | - name: write |
| 275 | - name: scaleio.system_workload_primary_io_size_total |
| 276 | description: Primary Backend I/O Size Total (Read and Write) |
| 277 | unit: KiB |
| 278 | chart_type: line |
| 279 | dimensions: |
| 280 | - name: io_size |
| 281 | - name: scaleio.system_rebalance |
| 282 | description: Rebalance |
| 283 | unit: KiB/s |
| 284 | chart_type: area |
| 285 | dimensions: |
| 286 | - name: read |
| 287 | - name: write |
| 288 | - name: scaleio.system_rebalance_left |
| 289 | description: Rebalance Pending Capacity |
| 290 | unit: KiB |
| 291 | chart_type: line |
| 292 | dimensions: |
| 293 | - name: left |
| 294 | - name: scaleio.system_rebalance_time_until_finish |
| 295 | description: Rebalance Approximate Time Until Finish |
| 296 | unit: seconds |
| 297 | chart_type: line |
| 298 | dimensions: |
| 299 | - name: time |
| 300 | - name: scaleio.system_rebuild |
| 301 | description: Rebuild Bandwidth Total (Forward, Backward and Normal) |
| 302 | unit: KiB/s |
| 303 | chart_type: area |
| 304 | dimensions: |
| 305 | - name: read |
| 306 | - name: write |
| 307 | - name: scaleio.system_rebuild_left |
| 308 | description: Rebuild Pending Capacity Total (Forward, Backward and Normal) |
| 309 | unit: KiB |
| 310 | chart_type: line |
| 311 | dimensions: |
| 312 | - name: left |
| 313 | - name: scaleio.system_defined_components |
| 314 | description: Components |
| 315 | unit: components |
| 316 | chart_type: line |
| 317 | dimensions: |
| 318 | - name: devices |
| 319 | - name: fault_sets |
| 320 | - name: protection_domains |
| 321 | - name: rfcache_devices |
| 322 | - name: sdc |
| 323 | - name: sds |
| 324 | - name: snapshots |
| 325 | - name: storage_pools |
| 326 | - name: volumes |
| 327 | - name: vtrees |
| 328 | - name: scaleio.system_components_volumes_by_type |
| 329 | description: Volumes By Type |
| 330 | unit: volumes |
| 331 | chart_type: stacked |
| 332 | dimensions: |
| 333 | - name: thick |
| 334 | - name: thin |
| 335 | - name: scaleio.system_components_volumes_by_mapping |
| 336 | description: Volumes By Mapping |
| 337 | unit: volumes |
| 338 | chart_type: stacked |
| 339 | dimensions: |
| 340 | - name: mapped |
| 341 | - name: unmapped |
| 342 | - name: storage pool |
| 343 | description: These metrics refer to the storage pool. |
| 344 | labels: [] |
| 345 | metrics: |
| 346 | - name: scaleio.storage_pool_capacity_total |
| 347 | description: Total Capacity |
| 348 | unit: KiB |
| 349 | chart_type: line |
| 350 | dimensions: |
| 351 | - name: total |
| 352 | - name: scaleio.storage_pool_capacity_in_use |
| 353 | description: Capacity In Use |
| 354 | unit: KiB |
| 355 | chart_type: line |
| 356 | dimensions: |
| 357 | - name: in_use |
| 358 | - name: scaleio.storage_pool_capacity_usage |
| 359 | description: Capacity Usage |
| 360 | unit: KiB |
| 361 | chart_type: stacked |
| 362 | dimensions: |
| 363 | - name: thick |
| 364 | - name: decreased |
| 365 | - name: thin |
| 366 | - name: snapshot |
| 367 | - name: spare |
| 368 | - name: unused |
| 369 | - name: scaleio.storage_pool_capacity_utilization |
| 370 | description: Capacity Utilization |
| 371 | unit: percentage |
| 372 | chart_type: line |
| 373 | dimensions: |
| 374 | - name: used |
| 375 | - name: scaleio.storage_pool_capacity_available_volume_allocation |
| 376 | description: Available For Volume Allocation |
| 377 | unit: KiB |
| 378 | chart_type: line |
| 379 | dimensions: |
| 380 | - name: available |
| 381 | - name: scaleio.storage_pool_capacity_health_state |
| 382 | description: Capacity Health State |
| 383 | unit: KiB |
| 384 | chart_type: stacked |
| 385 | dimensions: |
| 386 | - name: protected |
| 387 | - name: degraded |
| 388 | - name: in_maintenance |
| 389 | - name: failed |
| 390 | - name: unavailable |
| 391 | - name: scaleio.storage_pool_components |
| 392 | description: Components |
| 393 | unit: components |
| 394 | chart_type: line |
| 395 | dimensions: |
| 396 | - name: devices |
| 397 | - name: snapshots |
| 398 | - name: volumes |
| 399 | - name: vtrees |
| 400 | - name: sdc |
| 401 | description: These metrics refer to the SDC (ScaleIO Data Client). |
| 402 | labels: [] |
| 403 | metrics: |
| 404 | - name: scaleio.sdc_mdm_connection_state |
| 405 | description: MDM Connection State |
| 406 | unit: boolean |
| 407 | chart_type: line |
| 408 | dimensions: |
| 409 | - name: connected |
| 410 | - name: scaleio.sdc_bandwidth |
| 411 | description: Bandwidth |
| 412 | unit: KiB/s |
| 413 | chart_type: area |
| 414 | dimensions: |
| 415 | - name: read |
| 416 | - name: write |
| 417 | - name: scaleio.sdc_iops |
| 418 | description: IOPS |
| 419 | unit: iops/s |
| 420 | chart_type: area |
| 421 | dimensions: |
| 422 | - name: read |
| 423 | - name: write |
| 424 | - name: scaleio.sdc_io_size |
| 425 | description: IOPS Size |
| 426 | unit: KiB |
| 427 | chart_type: area |
| 428 | dimensions: |
| 429 | - name: read |
| 430 | - name: write |
| 431 | - name: scaleio.sdc_num_of_mapped_volumed |
| 432 | description: Mapped Volumes |
| 433 | unit: volumes |
| 434 | chart_type: line |
| 435 | dimensions: |
| 436 | - name: mapped |