summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNetdata bot <43409846+netdatabot@users.noreply.github.com>2024-04-19 17:59:29 +0300
committerGitHub <noreply@github.com>2024-04-19 17:59:29 +0300
commit376b4d5f08d4238960e686747b798fe9d64111ba (patch)
treefa1d069bb72445215e789b285611c29dde63c90c
parentaf8404cebb4821e0fa682e27aeb9714278af6096 (diff)
Regenerate integrations.js (#17458)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
-rw-r--r--integrations/integrations.js38
-rw-r--r--integrations/integrations.json38
-rw-r--r--src/collectors/COLLECTORS.md2
l---------src/go/collectors/go.d.plugin/modules/storcli/README.md1
-rw-r--r--src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md189
5 files changed, 268 insertions, 0 deletions
diff --git a/integrations/integrations.js b/integrations/integrations.js
index cddcabd59c..0d9862d36f 100644
--- a/integrations/integrations.js
+++ b/integrations/integrations.js
@@ -15788,6 +15788,44 @@ export const integrations = [
},
{
"meta": {
+ "id": "collector-go.d.plugin-storcli",
+ "plugin_name": "go.d.plugin",
+ "module_name": "storcli",
+ "monitored_instance": {
+ "name": "StoreCLI RAID",
+ "link": "https://docs.broadcom.com/doc/12352476",
+ "icon_filename": "hard-drive.svg",
+ "categories": [
+ "data-collection.storage-mount-points-and-filesystems"
+ ]
+ },
+ "keywords": [
+ "storage",
+ "raid-controller",
+ "manage-disks"
+ ],
+ "related_resources": {
+ "integrations": {
+ "list": []
+ }
+ },
+ "info_provided_to_referring_integrations": {
+ "description": ""
+ },
+ "most_popular": false
+ },
+ "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",
+ "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",
+ "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",
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
+ "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",
+ "integration_type": "collector",
+ "id": "go.d.plugin-storcli-StoreCLI_RAID",
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml",
+ "related_resources": ""
+ },
+ {
+ "meta": {
"id": "collector-go.d.plugin-supervisord",
"plugin_name": "go.d.plugin",
"module_name": "supervisord",
diff --git a/integrations/integrations.json b/integrations/integrations.json
index 36987d3f62..a88476e2a8 100644
--- a/integrations/integrations.json
+++ b/integrations/integrations.json
@@ -15786,6 +15786,44 @@
},
{
"meta": {
+ "id": "collector-go.d.plugin-storcli",
+ "plugin_name": "go.d.plugin",
+ "module_name": "storcli",
+ "monitored_instance": {
+ "name": "StoreCLI RAID",
+ "link": "https://docs.broadcom.com/doc/12352476",
+ "icon_filename": "hard-drive.svg",
+ "categories": [
+ "data-collection.storage-mount-points-and-filesystems"
+ ]
+ },
+ "keywords": [
+ "storage",
+ "raid-controller",
+ "manage-disks"
+ ],
+ "related_resources": {
+ "integrations": {
+ "list": []
+ }
+ },
+ "info_provided_to_referring_integrations": {
+ "description": ""
+ },
+ "most_popular": false
+ },
+ "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",
+ "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",
+ "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",
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
+ "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",
+ "integration_type": "collector",
+ "id": "go.d.plugin-storcli-StoreCLI_RAID",
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml",
+ "related_resources": ""
+ },
+ {
+ "meta": {
"id": "collector-go.d.plugin-supervisord",
"plugin_name": "go.d.plugin",
"module_name": "supervisord",
diff --git a/src/collectors/COLLECTORS.md b/src/collectors/COLLECTORS.md
index e0c22df25c..26b81e77ec 100644
--- a/src/collectors/COLLECTORS.md
+++ b/src/collectors/COLLECTORS.md
@@ -1039,6 +1039,8 @@ If you don't see the app/service you'd like to monitor in this list:
- [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)
+- [StoreCLI RAID](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md)
+
- [Storidge](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/storidge.md)
- [Synology ActiveBackup](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/synology_activebackup.md)
diff --git a/src/go/collectors/go.d.plugin/modules/storcli/README.md b/src/go/collectors/go.d.plugin/modules/storcli/README.md
new file mode 120000
index 0000000000..482049b19a
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/storcli/README.md
@@ -0,0 +1 @@
+integrations/storecli_raid.md \ No newline at end of file
diff --git a/src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md b/src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md
new file mode 100644
index 0000000000..bc4f81de14
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/storcli/integrations/storecli_raid.md
@@ -0,0 +1,189 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/storcli/README.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/storcli/metadata.yaml"
+sidebar_label: "StoreCLI RAID"
+learn_status: "Published"
+learn_rel_path: "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-->
+
+# StoreCLI RAID
+
+
+<img src="https://netdata.cloud/img/hard-drive.svg" width="150"/>
+
+
+Plugin: go.d.plugin
+Module: storcli
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Overview
+
+Monitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system.
+It relies on the [`storcli`](https://docs.broadcom.com/doc/12352476) CLI tool but avoids directly executing the binary.
+Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.
+This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
+
+Executed commands:
+- `storcli /cALL show all J nolog`
+- `storcli /cALL/eALL/sALL show all J nolog`
+
+
+
+
+This collector is supported on all platforms.
+
+This collector only supports collecting metrics from a single instance of this integration.
+
+
+### Default Behavior
+
+#### Auto-Detection
+
+This integration doesn't support auto-detection.
+
+#### Limits
+
+The default configuration for this integration does not impose any limits on data collection.
+
+#### Performance Impact
+
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
+
+
+## Metrics
+
+Metrics grouped by *scope*.
+
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
+
+
+
+### Per controller
+
+These metrics refer to the Controller.
+
+Labels:
+
+| Label | Description |
+|:-----------|:----------------|
+| controller_number | Controller number (index) |
+| model | Controller model |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| storcli.controller_status | optimal, degraded, partially_degraded, failed | status |
+| storcli.controller_bbu_status | healthy, unhealthy, na | status |
+
+### Per physical drive
+
+These metrics refer to the Physical Drive.
+
+Labels:
+
+| Label | Description |
+|:-----------|:----------------|
+| controller_number | Controller number (index) |
+| enclosure_number | Enclosure number (index) |
+| slot_number | Slot number (index) |
+| media type | Media type (e.g. HDD) |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| storcli.phys_drive_errors | media, other | errors/s |
+| storcli.phys_drive_predictive_failures | predictive_failures | failures/s |
+| storcli.phys_drive_smart_alert_status | active, inactive | status |
+| storcli.phys_drive_temperature | temperature | status |
+
+
+
+## Alerts
+
+There are no alerts configured by default for this integration.
+
+
+## Setup
+
+### Prerequisites
+
+No action required.
+
+### Configuration
+
+#### File
+
+The configuration file name for this integration is `go.d/storcli.conf`.
+
+
+You can edit the configuration file using the `edit-config` script from the
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
+
+```bash
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
+sudo ./edit-config go.d/storcli.conf
+```
+#### Options
+
+The following options can be defined globally: update_every.
+
+
+<details><summary>Config options</summary>
+
+| Name | Description | Default | Required |
+|:----|:-----------|:-------|:--------:|
+| update_every | Data collection frequency. | 10 | no |
+| timeout | storcli binary execution timeout. | 2 | no |
+
+</details>
+
+#### Examples
+
+##### Custom update_every
+
+Allows you to override the default data collection interval.
+
+<details><summary>Config</summary>
+
+```yaml
+jobs:
+ - name: storcli
+ update_every: 5 # Collect StorCLI RAID statistics every 5 seconds
+
+```
+</details>
+
+
+
+## Troubleshooting
+
+### Debug Mode
+
+To troubleshoot issues with the `storcli` 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 storcli
+ ```
+
+