github.com/netdata/go.d.plugin@v0.58.1/modules/scaleio/metadata.yaml (about) 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-mount-points-and-filesystems 13 keywords: 14 - scaleio 15 related_resources: 16 integrations: 17 list: [] 18 info_provided_to_referring_integrations: 19 description: "" 20 most_popular: false 21 overview: 22 data_collection: 23 metrics_description: | 24 This collector monitors ScaleIO (VxFlex OS) instances via VxFlex OS Gateway API. 25 26 It collects metrics for the following ScaleIO components: 27 28 - System 29 - Storage Pool 30 - Sdc 31 method_description: "" 32 supported_platforms: 33 include: [] 34 exclude: [] 35 multi_instance: true 36 additional_permissions: 37 description: "" 38 default_behavior: 39 auto_detection: 40 description: "" 41 limits: 42 description: "" 43 performance_impact: 44 description: "" 45 setup: 46 prerequisites: 47 list: [] 48 configuration: 49 file: 50 name: go.d/scaleio.conf 51 options: 52 description: | 53 The following options can be defined globally: update_every, autodetection_retry. 54 folding: 55 title: Config options 56 enabled: true 57 list: 58 - name: update_every 59 description: Data collection frequency. 60 default_value: 5 61 required: false 62 - name: autodetection_retry 63 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 64 default_value: 0 65 required: false 66 - name: url 67 description: Server URL. 68 default_value: https://127.0.0.1:80 69 required: true 70 - name: timeout 71 description: HTTP request timeout. 72 default_value: 1 73 required: false 74 - name: username 75 description: Username for basic HTTP authentication. 76 default_value: "" 77 required: true 78 - name: password 79 description: Password for basic HTTP authentication. 80 default_value: "" 81 required: true 82 - name: proxy_url 83 description: Proxy URL. 84 default_value: "" 85 required: false 86 - name: proxy_username 87 description: Username for proxy basic HTTP authentication. 88 default_value: "" 89 required: false 90 - name: proxy_password 91 description: Password for proxy basic HTTP authentication. 92 default_value: "" 93 required: false 94 - name: method 95 description: HTTP request method. 96 default_value: GET 97 required: false 98 - name: body 99 description: HTTP request body. 100 default_value: "" 101 required: false 102 - name: headers 103 description: HTTP request headers. 104 default_value: "" 105 required: false 106 - name: not_follow_redirects 107 description: Redirect handling policy. Controls whether the client follows redirects. 108 default_value: false 109 required: false 110 - name: tls_skip_verify 111 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 112 default_value: false 113 required: false 114 - name: tls_ca 115 description: Certification authority that the client uses when verifying the server's certificates. 116 default_value: "" 117 required: false 118 - name: tls_cert 119 description: Client TLS certificate. 120 default_value: "" 121 required: false 122 - name: tls_key 123 description: Client TLS key. 124 default_value: "" 125 required: false 126 examples: 127 folding: 128 title: Config 129 enabled: true 130 list: 131 - name: Basic 132 description: An example configuration. 133 config: | 134 jobs: 135 - name: local 136 url: https://127.0.0.1 137 username: admin 138 password: password 139 tls_skip_verify: yes # self-signed certificate 140 - name: Multi-instance 141 description: | 142 > **Note**: When you define multiple jobs, their names must be unique. 143 144 Local and remote instance. 145 config: | 146 jobs: 147 - name: local 148 url: https://127.0.0.1 149 username: admin 150 password: password 151 tls_skip_verify: yes # self-signed certificate 152 153 - name: remote 154 url: https://203.0.113.10 155 username: admin 156 password: password 157 tls_skip_verify: yes 158 troubleshooting: 159 problems: 160 list: [] 161 alerts: [] 162 metrics: 163 folding: 164 title: Metrics 165 enabled: false 166 description: "" 167 availability: [] 168 scopes: 169 - name: global 170 description: These metrics refer to the entire monitored application. 171 labels: [] 172 metrics: 173 - name: scaleio.system_capacity_total 174 description: Total Capacity 175 unit: KiB 176 chart_type: line 177 dimensions: 178 - name: total 179 - name: scaleio.system_capacity_in_use 180 description: Capacity In Use 181 unit: KiB 182 chart_type: line 183 dimensions: 184 - name: in_use 185 - name: scaleio.system_capacity_usage 186 description: Capacity Usage 187 unit: KiB 188 chart_type: stacked 189 dimensions: 190 - name: thick 191 - name: decreased 192 - name: thin 193 - name: snapshot 194 - name: spare 195 - name: unused 196 - name: scaleio.system_capacity_available_volume_allocation 197 description: Available For Volume Allocation 198 unit: KiB 199 chart_type: line 200 dimensions: 201 - name: available 202 - name: scaleio.system_capacity_health_state 203 description: Capacity Health State 204 unit: KiB 205 chart_type: stacked 206 dimensions: 207 - name: protected 208 - name: degraded 209 - name: in_maintenance 210 - name: failed 211 - name: unavailable 212 - name: scaleio.system_workload_primary_bandwidth_total 213 description: Primary Backend Bandwidth Total (Read and Write) 214 unit: KiB/s 215 chart_type: line 216 dimensions: 217 - name: total 218 - name: scaleio.system_workload_primary_bandwidth 219 description: Primary Backend Bandwidth 220 unit: KiB/s 221 chart_type: area 222 dimensions: 223 - name: read 224 - name: write 225 - name: scaleio.system_workload_primary_iops_total 226 description: Primary Backend IOPS Total (Read and Write) 227 unit: iops/s 228 chart_type: line 229 dimensions: 230 - name: total 231 - name: scaleio.system_workload_primary_iops 232 description: Primary Backend IOPS 233 unit: iops/s 234 chart_type: area 235 dimensions: 236 - name: read 237 - name: write 238 - name: scaleio.system_workload_primary_io_size_total 239 description: Primary Backend I/O Size Total (Read and Write) 240 unit: KiB 241 chart_type: line 242 dimensions: 243 - name: io_size 244 - name: scaleio.system_rebalance 245 description: Rebalance 246 unit: KiB/s 247 chart_type: area 248 dimensions: 249 - name: read 250 - name: write 251 - name: scaleio.system_rebalance_left 252 description: Rebalance Pending Capacity 253 unit: KiB 254 chart_type: line 255 dimensions: 256 - name: left 257 - name: scaleio.system_rebalance_time_until_finish 258 description: Rebalance Approximate Time Until Finish 259 unit: seconds 260 chart_type: line 261 dimensions: 262 - name: time 263 - name: scaleio.system_rebuild 264 description: Rebuild Bandwidth Total (Forward, Backward and Normal) 265 unit: KiB/s 266 chart_type: area 267 dimensions: 268 - name: read 269 - name: write 270 - name: scaleio.system_rebuild_left 271 description: Rebuild Pending Capacity Total (Forward, Backward and Normal) 272 unit: KiB 273 chart_type: line 274 dimensions: 275 - name: left 276 - name: scaleio.system_defined_components 277 description: Components 278 unit: components 279 chart_type: line 280 dimensions: 281 - name: devices 282 - name: fault_sets 283 - name: protection_domains 284 - name: rfcache_devices 285 - name: sdc 286 - name: sds 287 - name: snapshots 288 - name: storage_pools 289 - name: volumes 290 - name: vtrees 291 - name: scaleio.system_components_volumes_by_type 292 description: Volumes By Type 293 unit: volumes 294 chart_type: stacked 295 dimensions: 296 - name: thick 297 - name: thin 298 - name: scaleio.system_components_volumes_by_mapping 299 description: Volumes By Mapping 300 unit: volumes 301 chart_type: stacked 302 dimensions: 303 - name: mapped 304 - name: unmapped 305 - name: storage pool 306 description: These metrics refer to the storage pool. 307 labels: [] 308 metrics: 309 - name: scaleio.storage_pool_capacity_total 310 description: Total Capacity 311 unit: KiB 312 chart_type: line 313 dimensions: 314 - name: total 315 - name: scaleio.storage_pool_capacity_in_use 316 description: Capacity In Use 317 unit: KiB 318 chart_type: line 319 dimensions: 320 - name: in_use 321 - name: scaleio.storage_pool_capacity_usage 322 description: Capacity Usage 323 unit: KiB 324 chart_type: stacked 325 dimensions: 326 - name: thick 327 - name: decreased 328 - name: thin 329 - name: snapshot 330 - name: spare 331 - name: unused 332 - name: scaleio.storage_pool_capacity_utilization 333 description: Capacity Utilization 334 unit: percentage 335 chart_type: line 336 dimensions: 337 - name: used 338 - name: scaleio.storage_pool_capacity_available_volume_allocation 339 description: Available For Volume Allocation 340 unit: KiB 341 chart_type: line 342 dimensions: 343 - name: available 344 - name: scaleio.storage_pool_capacity_health_state 345 description: Capacity Health State 346 unit: KiB 347 chart_type: stacked 348 dimensions: 349 - name: protected 350 - name: degraded 351 - name: in_maintenance 352 - name: failed 353 - name: unavailable 354 - name: scaleio.storage_pool_components 355 description: Components 356 unit: components 357 chart_type: line 358 dimensions: 359 - name: devices 360 - name: snapshots 361 - name: volumes 362 - name: vtrees 363 - name: sdc 364 description: These metrics refer to the SDC (ScaleIO Data Client). 365 labels: [] 366 metrics: 367 - name: scaleio.sdc_mdm_connection_state 368 description: MDM Connection State 369 unit: boolean 370 chart_type: line 371 dimensions: 372 - name: connected 373 - name: scaleio.sdc_bandwidth 374 description: Bandwidth 375 unit: KiB/s 376 chart_type: area 377 dimensions: 378 - name: read 379 - name: write 380 - name: scaleio.sdc_iops 381 description: IOPS 382 unit: iops/s 383 chart_type: area 384 dimensions: 385 - name: read 386 - name: write 387 - name: scaleio.sdc_io_size 388 description: IOPS Size 389 unit: KiB 390 chart_type: area 391 dimensions: 392 - name: read 393 - name: write 394 - name: scaleio.sdc_num_of_mapped_volumed 395 description: Mapped Volumes 396 unit: volumes 397 chart_type: line 398 dimensions: 399 - name: mapped