Regenerate integrations.js (#17458)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 19, 2024 at 17:59 UTC
376b4d5f08d4238960e686747b798fe9d64111ba
5 files changed
+268
integrations/integrations.js
+38
@@ -15786,6 +15786,44 @@ export const integrations = [
15786
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/squidlog/metadata.yaml",
15787
"related_resources": ""
15788
},
15789
+ {
15790
+ "meta": {
15791
+ "id": "collector-go.d.plugin-storcli",
15792
+ "plugin_name": "go.d.plugin",
15793
+ "module_name": "storcli",
15794
+ "monitored_instance": {
15795
+ "name": "StoreCLI RAID",
15796
+ "link": "https://docs.broadcom.com/doc/12352476",
15797
+ "icon_filename": "hard-drive.svg",
15798
+ "categories": [
15799
+ "data-collection.storage-mount-points-and-filesystems"
15800
+ ]
15801
+ },
15802
+ "keywords": [
15803
+ "storage",
15804
+ "raid-controller",
15805
+ "manage-disks"
15806
+ ],
15807
+ "related_resources": {
15808
+ "integrations": {
15809
+ "list": []
15810
+ }
15811
+ },
15812
+ "info_provided_to_referring_integrations": {
15813
+ "description": ""
15814
+ },
15815
+ "most_popular": false
15816
+ },
15817
+ "overview": "# StoreCLI RAID\n\nPlugin: go.d.plugin\nModule: storcli\n\n## Overview\n\nMonitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system.\nIt relies on the [`storcli`](https://docs.broadcom.com/doc/12352476) CLI tool but avoids directly executing the binary.\nInstead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.\nThis approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\nExecuted commands:\n- `storcli /cALL show all J nolog`\n- `storcli /cALL/eALL/sALL show all J nolog`\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15818
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/storcli.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/storcli.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | storcli binary execution timeout. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: storcli\n update_every: 5 # Collect StorCLI RAID statistics every 5 seconds\n\n```\n{% /details %}\n",
15819
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `storcli` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m storcli\n ```\n\n",
15820
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15821
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per controller\n\nThese metrics refer to the Controller.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| controller_number | Controller number (index) |\n| model | Controller model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| storcli.controller_status | optimal, degraded, partially_degraded, failed | status |\n| storcli.controller_bbu_status | healthy, unhealthy, na | status |\n\n### Per physical drive\n\nThese metrics refer to the Physical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| controller_number | Controller number (index) |\n| enclosure_number | Enclosure number (index) |\n| slot_number | Slot number (index) |\n| media type | Media type (e.g. HDD) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| storcli.phys_drive_errors | media, other | errors/s |\n| storcli.phys_drive_predictive_failures | predictive_failures | failures/s |\n| storcli.phys_drive_smart_alert_status | active, inactive | status |\n| storcli.phys_drive_temperature | temperature | status |\n\n",
15822
+ "integration_type": "collector",
15823
+ "id": "go.d.plugin-storcli-StoreCLI_RAID",
15824
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml",
15825
+ "related_resources": ""
15826
+ },
15827
{
15828
"meta": {
15829
"id": "collector-go.d.plugin-supervisord",
integrations/integrations.json
+38
@@ -15784,6 +15784,44 @@
15784
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/squidlog/metadata.yaml",
15785
"related_resources": ""
15786
},
15787
+ {
15788
+ "meta": {
15789
+ "id": "collector-go.d.plugin-storcli",
15790
+ "plugin_name": "go.d.plugin",
15791
+ "module_name": "storcli",
15792
+ "monitored_instance": {
15793
+ "name": "StoreCLI RAID",
15794
+ "link": "https://docs.broadcom.com/doc/12352476",
15795
+ "icon_filename": "hard-drive.svg",
15796
+ "categories": [
15797
+ "data-collection.storage-mount-points-and-filesystems"
15798
+ ]
15799
+ },
15800
+ "keywords": [
15801
+ "storage",
15802
+ "raid-controller",
15803
+ "manage-disks"
15804
+ ],
15805
+ "related_resources": {
15806
+ "integrations": {
15807
+ "list": []
15808
+ }
15809
+ },
15810
+ "info_provided_to_referring_integrations": {
15811
+ "description": ""
15812
+ },
15813
+ "most_popular": false
15814
+ },
15815
+ "overview": "# StoreCLI RAID\n\nPlugin: go.d.plugin\nModule: storcli\n\n## Overview\n\nMonitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system.\nIt relies on the [`storcli`](https://docs.broadcom.com/doc/12352476) CLI tool but avoids directly executing the binary.\nInstead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.\nThis approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\nExecuted commands:\n- `storcli /cALL show all J nolog`\n- `storcli /cALL/eALL/sALL show all J nolog`\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15816
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/storcli.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/storcli.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | storcli binary execution timeout. | 2 | no |\n\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: storcli\n update_every: 5 # Collect StorCLI RAID statistics every 5 seconds\n\n```\n",
15817
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `storcli` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m storcli\n ```\n\n",
15818
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15819
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per controller\n\nThese metrics refer to the Controller.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| controller_number | Controller number (index) |\n| model | Controller model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| storcli.controller_status | optimal, degraded, partially_degraded, failed | status |\n| storcli.controller_bbu_status | healthy, unhealthy, na | status |\n\n### Per physical drive\n\nThese metrics refer to the Physical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| controller_number | Controller number (index) |\n| enclosure_number | Enclosure number (index) |\n| slot_number | Slot number (index) |\n| media type | Media type (e.g. HDD) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| storcli.phys_drive_errors | media, other | errors/s |\n| storcli.phys_drive_predictive_failures | predictive_failures | failures/s |\n| storcli.phys_drive_smart_alert_status | active, inactive | status |\n| storcli.phys_drive_temperature | temperature | status |\n\n",
15820
+ "integration_type": "collector",
15821
+ "id": "go.d.plugin-storcli-StoreCLI_RAID",
15822
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml",
15823
+ "related_resources": ""
15824
+ },
15825
{
15826
"meta": {
15827
"id": "collector-go.d.plugin-supervisord",
src/collectors/COLLECTORS.md
+2
@@ -1039,6 +1039,8 @@ If you don't see the app/service you'd like to monitor in this list:
1039
1040
- [Starwind VSAN VSphere Edition](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/starwind_vsan_vsphere_edition.md)
1041
1042
+- [StoreCLI RAID](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md)
1043
+
1044
- [Storidge](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/storidge.md)
1045
1046
- [Synology ActiveBackup](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/synology_activebackup.md)
src/go/collectors/go.d.plugin/modules/storcli/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/storecli_raid.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md
new
+189
@@ -0,0 +1,189 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/storcli/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml"
4
+sidebar_label: "StoreCLI RAID"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# StoreCLI RAID
12
+
13
+
14
+<img src="https://netdata.cloud/img/hard-drive.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: storcli
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+Monitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system.
25
+It relies on the [`storcli`](https://docs.broadcom.com/doc/12352476) CLI tool but avoids directly executing the binary.
26
+Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.
27
+This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
28
+
29
+Executed commands:
30
+- `storcli /cALL show all J nolog`
31
+- `storcli /cALL/eALL/sALL show all J nolog`
32
+
33
+
34
+
35
+
36
+This collector is supported on all platforms.
37
+
38
+This collector only supports collecting metrics from a single instance of this integration.
39
+
40
+
41
+### Default Behavior
42
+
43
+#### Auto-Detection
44
+
45
+This integration doesn't support auto-detection.
46
+
47
+#### Limits
48
+
49
+The default configuration for this integration does not impose any limits on data collection.
50
+
51
+#### Performance Impact
52
+
53
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
54
+
55
+
56
+## Metrics
57
+
58
+Metrics grouped by *scope*.
59
+
60
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
61
+
62
+
63
+
64
+### Per controller
65
+
66
+These metrics refer to the Controller.
67
+
68
+Labels:
69
+
70
+| Label | Description |
71
+|:-----------|:----------------|
72
+| controller_number | Controller number (index) |
73
+| model | Controller model |
74
+
75
+Metrics:
76
+
77
+| Metric | Dimensions | Unit |
78
+|:------|:----------|:----|
79
+| storcli.controller_status | optimal, degraded, partially_degraded, failed | status |
80
+| storcli.controller_bbu_status | healthy, unhealthy, na | status |
81
+
82
+### Per physical drive
83
+
84
+These metrics refer to the Physical Drive.
85
+
86
+Labels:
87
+
88
+| Label | Description |
89
+|:-----------|:----------------|
90
+| controller_number | Controller number (index) |
91
+| enclosure_number | Enclosure number (index) |
92
+| slot_number | Slot number (index) |
93
+| media type | Media type (e.g. HDD) |
94
+
95
+Metrics:
96
+
97
+| Metric | Dimensions | Unit |
98
+|:------|:----------|:----|
99
+| storcli.phys_drive_errors | media, other | errors/s |
100
+| storcli.phys_drive_predictive_failures | predictive_failures | failures/s |
101
+| storcli.phys_drive_smart_alert_status | active, inactive | status |
102
+| storcli.phys_drive_temperature | temperature | status |
103
+
104
+
105
+
106
+## Alerts
107
+
108
+There are no alerts configured by default for this integration.
109
+
110
+
111
+## Setup
112
+
113
+### Prerequisites
114
+
115
+No action required.
116
+
117
+### Configuration
118
+
119
+#### File
120
+
121
+The configuration file name for this integration is `go.d/storcli.conf`.
122
+
123
+
124
+You can edit the configuration file using the `edit-config` script from the
125
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
126
+
127
+```bash
128
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
129
+sudo ./edit-config go.d/storcli.conf
130
+```
131
+#### Options
132
+
133
+The following options can be defined globally: update_every.
134
+
135
+
136
+<details><summary>Config options</summary>
137
+
138
+| Name | Description | Default | Required |
139
+|:----|:-----------|:-------|:--------:|
140
+| update_every | Data collection frequency. | 10 | no |
141
+| timeout | storcli binary execution timeout. | 2 | no |
142
+
143
+</details>
144
+
145
+#### Examples
146
+
147
+##### Custom update_every
148
+
149
+Allows you to override the default data collection interval.
150
+
151
+<details><summary>Config</summary>
152
+
153
+```yaml
154
+jobs:
155
+ - name: storcli
156
+ update_every: 5 # Collect StorCLI RAID statistics every 5 seconds
157
+
158
+```
159
+</details>
160
+
161
+
162
+
163
+## Troubleshooting
164
+
165
+### Debug Mode
166
+
167
+To troubleshoot issues with the `storcli` collector, run the `go.d.plugin` with the debug option enabled. The output
168
+should give you clues as to why the collector isn't working.
169
+
170
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
171
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
172
+
173
+ ```bash
174
+ cd /usr/libexec/netdata/plugins.d/
175
+ ```
176
+
177
+- Switch to the `netdata` user.
178
+
179
+ ```bash
180
+ sudo -u netdata -s
181
+ ```
182
+
183
+- Run the `go.d.plugin` to debug the collector:
184
+
185
+ ```bash
186
+ ./go.d.plugin -d -m storcli
187
+ ```
188
+
189
+