| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-storcli |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: storcli |
| 7 | monitored_instance: |
| 8 | name: StoreCLI RAID |
| 9 | link: "https://docs.broadcom.com/doc/12352476" |
| 10 | icon_filename: "hard-drive.svg" |
| 11 | categories: |
| 12 | - data-collection.storage |
| 13 | keywords: |
| 14 | - storage |
| 15 | - raid-controller |
| 16 | - manage-disks |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | Monitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system. |
| 26 | It relies on the [`storcli`](https://docs.broadcom.com/doc/12352476) CLI tool but avoids directly executing the binary. |
| 27 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 28 | This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. |
| 29 | |
| 30 | Executed commands: |
| 31 | - `storcli /cALL show all J nolog` |
| 32 | - `storcli /cALL/eALL/sALL show all J nolog` |
| 33 | method_description: "" |
| 34 | supported_platforms: |
| 35 | include: [Linux, BSD] |
| 36 | exclude: [] |
| 37 | multi_instance: false |
| 38 | additional_permissions: |
| 39 | description: "" |
| 40 | default_behavior: |
| 41 | auto_detection: |
| 42 | description: "" |
| 43 | limits: |
| 44 | description: "" |
| 45 | performance_impact: |
| 46 | description: "" |
| 47 | setup: |
| 48 | prerequisites: |
| 49 | list: [] |
| 50 | configuration: |
| 51 | file: |
| 52 | name: go.d/storcli.conf |
| 53 | options: |
| 54 | description: | |
| 55 | The following options can be defined globally: update_every. |
| 56 | folding: |
| 57 | title: Config options |
| 58 | enabled: true |
| 59 | list: |
| 60 | - name: update_every |
| 61 | description: Data collection frequency. |
| 62 | default_value: 10 |
| 63 | required: false |
| 64 | - name: timeout |
| 65 | description: storcli binary execution timeout. |
| 66 | default_value: 2 |
| 67 | required: false |
| 68 | examples: |
| 69 | folding: |
| 70 | title: Config |
| 71 | enabled: true |
| 72 | list: |
| 73 | - name: Custom update_every |
| 74 | description: Allows you to override the default data collection interval. |
| 75 | config: | |
| 76 | jobs: |
| 77 | - name: storcli |
| 78 | update_every: 5 # Collect StorCLI RAID statistics every 5 seconds |
| 79 | troubleshooting: |
| 80 | problems: |
| 81 | list: [] |
| 82 | alerts: |
| 83 | - name: storcli_controller_health_status |
| 84 | metric: storcli.controller_health_status |
| 85 | info: RAID controller ${label:controller_number} is unhealthy |
| 86 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/storcli.conf |
| 87 | - name: storcli_controller_bbu_status |
| 88 | metric: storcli.controller_bbu_status |
| 89 | info: RAID controller ${label:controller_number} BBU is unhealthy |
| 90 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/storcli.conf |
| 91 | - name: storcli_phys_drive_errors |
| 92 | metric: storcli.phys_drive_errors |
| 93 | info: RAID physical drive c${label:controller_number}/e${label:enclosure_number}/s${label:slot_number} errors |
| 94 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/storcli.conf |
| 95 | - name: storcli_phys_drive_predictive_failures |
| 96 | metric: storcli.phys_drive_predictive_failures |
| 97 | info: RAID physical drive c${label:controller_number}/e${label:enclosure_number}/s${label:slot_number} predictive failures |
| 98 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/storcli.conf |
| 99 | metrics: |
| 100 | folding: |
| 101 | title: Metrics |
| 102 | enabled: false |
| 103 | description: "" |
| 104 | availability: [] |
| 105 | scopes: |
| 106 | - name: controller |
| 107 | description: These metrics refer to the Controller. |
| 108 | labels: |
| 109 | - name: controller_number |
| 110 | description: Controller number (index) |
| 111 | - name: model |
| 112 | description: Controller model |
| 113 | - name: driver_name |
| 114 | description: Controller driver (megaraid_sas or mpt3sas) |
| 115 | metrics: |
| 116 | - name: storcli.controller_health_status |
| 117 | description: Controller health status |
| 118 | unit: status |
| 119 | chart_type: line |
| 120 | dimensions: |
| 121 | - name: healthy |
| 122 | - name: unhealthy |
| 123 | - name: storcli.controller_status |
| 124 | description: Controller status |
| 125 | unit: status |
| 126 | chart_type: line |
| 127 | dimensions: |
| 128 | - name: optimal |
| 129 | - name: degraded |
| 130 | - name: partially_degraded |
| 131 | - name: failed |
| 132 | - name: storcli.controller_bbu_status |
| 133 | description: Controller BBU status |
| 134 | unit: status |
| 135 | chart_type: line |
| 136 | dimensions: |
| 137 | - name: healthy |
| 138 | - name: unhealthy |
| 139 | - name: na |
| 140 | - name: storcli.controller_roc_temperature |
| 141 | description: Controller ROC temperature |
| 142 | unit: Celsius |
| 143 | chart_type: line |
| 144 | dimensions: |
| 145 | - name: temperature |
| 146 | - name: physical drive |
| 147 | description: These metrics refer to the Physical Drive. |
| 148 | labels: |
| 149 | - name: controller_number |
| 150 | description: Controller number (index) |
| 151 | - name: enclosure_number |
| 152 | description: Enclosure number (index) |
| 153 | - name: slot_number |
| 154 | description: Slot number (index) |
| 155 | - name: media type |
| 156 | description: Media type (e.g. HDD) |
| 157 | metrics: |
| 158 | - name: storcli.phys_drive_errors |
| 159 | description: Physical Drive media errors rate |
| 160 | unit: errors/s |
| 161 | chart_type: line |
| 162 | dimensions: |
| 163 | - name: media |
| 164 | - name: other |
| 165 | - name: storcli.phys_drive_predictive_failures |
| 166 | description: Physical Drive predictive failures rate |
| 167 | unit: failures/s |
| 168 | chart_type: line |
| 169 | dimensions: |
| 170 | - name: predictive_failures |
| 171 | - name: storcli.phys_drive_smart_alert_status |
| 172 | description: Physical Drive SMART alert status |
| 173 | unit: status |
| 174 | chart_type: line |
| 175 | dimensions: |
| 176 | - name: active |
| 177 | - name: inactive |
| 178 | - name: storcli.phys_drive_temperature |
| 179 | description: Physical Drive temperature |
| 180 | unit: Celsius |
| 181 | chart_type: line |
| 182 | dimensions: |
| 183 | - name: temperature |
| 184 | - name: bbu |
| 185 | description: These metrics refer to the Backup Battery Unit. |
| 186 | labels: |
| 187 | - name: controller_number |
| 188 | description: Controller number (index) |
| 189 | - name: bbu_number |
| 190 | description: BBU number (index) |
| 191 | - name: model |
| 192 | description: BBU model |
| 193 | metrics: |
| 194 | - name: storcli.bbu_temperature |
| 195 | description: BBU temperature |
| 196 | unit: Celsius |
| 197 | chart_type: line |
| 198 | dimensions: |
| 199 | - name: temperature |