Regenerate integrations.js (#17652)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
May 14, 2024 at 11:23 UTC
34c305b8cb3c6c26e263d7c1808ebda5f5309806
5 files changed
+318
-77
integrations/integrations.js
+40
-38
@@ -4297,6 +4297,46 @@ export const integrations = [
4297
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hdfs/metadata.yaml",
4298
"related_resources": ""
4299
},
4300
+ {
4301
+ "meta": {
4302
+ "id": "collector-go.d.plugin-hpssa",
4303
+ "plugin_name": "go.d.plugin",
4304
+ "module_name": "hpssa",
4305
+ "monitored_instance": {
4306
+ "name": "HPE Smart Arrays",
4307
+ "link": "https://buy.hpe.com/us/en/options/controller-controller-options/smart-array-controllers-smart-host-bus-adapters/c/7109730",
4308
+ "icon_filename": "hp.svg",
4309
+ "categories": [
4310
+ "data-collection.storage-mount-points-and-filesystems"
4311
+ ]
4312
+ },
4313
+ "keywords": [
4314
+ "storage",
4315
+ "raid-controller",
4316
+ "hp",
4317
+ "hpssa",
4318
+ "array"
4319
+ ],
4320
+ "related_resources": {
4321
+ "integrations": {
4322
+ "list": []
4323
+ }
4324
+ },
4325
+ "info_provided_to_referring_integrations": {
4326
+ "description": ""
4327
+ },
4328
+ "most_popular": false
4329
+ },
4330
+ "overview": "# HPE Smart Arrays\n\nPlugin: go.d.plugin\nModule: hpssa\n\n## Overview\n\nMonitors the health of HPE Smart Arrays by tracking the status of controllers, arrays, logical and physical drives in your storage system.\nIt relies on the `ssacli` 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- `ssacli ctrl all show config detail`\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",
4331
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Install ssacli\n\nSee [official installation instructions](https://support.hpe.com/connect/s/softwaredetails?language=en_US&collectionId=MTX-0cb3f808e2514d3d).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/ssacli.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/ssacli.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 | ssacli 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: hpssa\n update_every: 5 # Collect HPE Smart Array statistics every 5 seconds\n\n```\n{% /details %}\n",
4332
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `hpssa` 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 hpssa\n ```\n\n",
4333
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
4334
+ "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| slot | Slot number |\n| model | Controller model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.controller_status | ok, nok | status |\n| hpssa.controller_temperature | temperature | Celsius |\n| hpssa.controller_cache_module_presence_status | present, not_present | status |\n| hpssa.controller_cache_module_status | ok, nok | status |\n| hpssa.controller_cache_module_temperature | temperature | Celsius |\n| hpssa.controller_cache_module_battery status | ok, nok | status |\n\n### Per array\n\nThese metrics refer to the Array.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id |\n| interface_type | Array interface type (e.g. SATA) |\n| array_type | Array type (e.g. Data) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.array_status | ok, nok | status |\n\n### Per logical drive\n\nThese metrics refer to the Logical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id |\n| logical_drive_id | Logical Drive id (number) |\n| disk_name | Disk name (e.g. /dev/sda) |\n| drive_type | Drive type (e.g. Data) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.logical_drive_status | ok, nok | status |\n\n### Per physical drive\n\nThese metrics refer to the Physical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id or \"na\" if unassigned |\n| logical_drive_id | Logical Drive id or \"na\" if unassigned |\n| location | Drive location in port:box:bay format (e.g. 1I:1:1) |\n| interface_type | Drive interface type (e.g. SATA) |\n| drive_type | Drive type (e.g. Data Drive, Unassigned Drive) |\n| model | Drive model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.physical_drive_status | ok, nok | status |\n| hpssa.physical_drive_temperature | temperature | status |\n\n",
4335
+ "integration_type": "collector",
4336
+ "id": "go.d.plugin-hpssa-HPE_Smart_Arrays",
4337
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hpssa/metadata.yaml",
4338
+ "related_resources": ""
4339
+ },
4340
{
4341
"meta": {
4342
"id": "collector-go.d.plugin-httpcheck",
@@ -18635,44 +18675,6 @@ export const integrations = [
18675
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/go_expvar/metadata.yaml",
18676
"related_resources": ""
18677
},
18638
- {
18639
- "meta": {
18640
- "plugin_name": "python.d.plugin",
18641
- "module_name": "hpssa",
18642
- "monitored_instance": {
18643
- "name": "HP Smart Storage Arrays",
18644
- "link": "https://buy.hpe.com/us/en/software/server-management-software/server-management-software/smart-array-management-software/hpe-smart-storage-administrator/p/5409020",
18645
- "categories": [
18646
- "data-collection.storage-mount-points-and-filesystems"
18647
- ],
18648
- "icon_filename": "hp.svg"
18649
- },
18650
- "related_resources": {
18651
- "integrations": {
18652
- "list": []
18653
- }
18654
- },
18655
- "info_provided_to_referring_integrations": {
18656
- "description": ""
18657
- },
18658
- "keywords": [
18659
- "storage",
18660
- "hp",
18661
- "hpssa",
18662
- "array"
18663
- ],
18664
- "most_popular": false
18665
- },
18666
- "overview": "# HP Smart Storage Arrays\n\nPlugin: python.d.plugin\nModule: hpssa\n\n## Overview\n\nThis collector monitors HP Smart Storage Arrays metrics about operational statuses and temperatures.\n\nIt uses the command line tool `ssacli`. The exact command used is `sudo -n ssacli ctrl all show config detail`\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\nIf no configuration is provided, the collector will try to execute the `ssacli` binary.\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",
18667
- "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the hpssa collector\n\nThe `hpssa` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.\n\n```bash\ncd /etc/netdata # Replace this path with your Netdata config directory, if different\nsudo ./edit-config python.d.conf\n```\n\nChange the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.\n\n\n#### Allow user netdata to execute `ssacli` as root.\n\nThis module uses `ssacli`, which can only be executed by root. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `ssacli` as root without a password.\n\n- Add to your `/etc/sudoers` file:\n\n`which ssacli` shows the full path to the binary.\n\n```bash\nnetdata ALL=(root) NOPASSWD: /path/to/ssacli\n```\n\n- Reset Netdata's systemd\n unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux\n distributions with systemd)\n\nThe default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `ssacli` using `sudo`.\n\nAs the `root` user, do the following:\n\n```cmd\nmkdir /etc/systemd/system/netdata.service.d\necho -e '[Service]\\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf\nsystemctl daemon-reload\nsystemctl restart netdata.service\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/hpssa.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 python.d/hpssa.conf\n```\n#### Options\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 5 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n| ssacli_path | Path to the `ssacli` command line utility. Configure this if `ssacli` is not in the $PATH | | no |\n| use_sudo | Whether or not to use `sudo` to execute `ssacli` | True | no |\n\n{% /details %}\n#### Examples\n\n##### Local simple config\n\nA basic configuration, specyfing the path to `ssacli`\n\n```yaml\nlocal:\n ssacli_path: /usr/sbin/ssacli\n\n```\n",
18668
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `hpssa` collector, run the `python.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 `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin hpssa debug trace\n ```\n\n",
18669
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
18670
- "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 HP Smart Storage Arrays instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.ctrl_status | ctrl_{adapter slot}_status, cache_{adapter slot}_status, battery_{adapter slot}_status per adapter | Status |\n| hpssa.ctrl_temperature | ctrl_{adapter slot}_temperature, cache_{adapter slot}_temperature per adapter | Celsius |\n| hpssa.ld_status | a dimension per logical drive | Status |\n| hpssa.pd_status | a dimension per physical drive | Status |\n| hpssa.pd_temperature | a dimension per physical drive | Celsius |\n\n",
18671
- "integration_type": "collector",
18672
- "id": "python.d.plugin-hpssa-HP_Smart_Storage_Arrays",
18673
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/hpssa/metadata.yaml",
18674
- "related_resources": ""
18675
- },
18678
{
18679
"meta": {
18680
"plugin_name": "python.d.plugin",
integrations/integrations.json
+40
-38
@@ -4295,6 +4295,46 @@
4295
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hdfs/metadata.yaml",
4296
"related_resources": ""
4297
},
4298
+ {
4299
+ "meta": {
4300
+ "id": "collector-go.d.plugin-hpssa",
4301
+ "plugin_name": "go.d.plugin",
4302
+ "module_name": "hpssa",
4303
+ "monitored_instance": {
4304
+ "name": "HPE Smart Arrays",
4305
+ "link": "https://buy.hpe.com/us/en/options/controller-controller-options/smart-array-controllers-smart-host-bus-adapters/c/7109730",
4306
+ "icon_filename": "hp.svg",
4307
+ "categories": [
4308
+ "data-collection.storage-mount-points-and-filesystems"
4309
+ ]
4310
+ },
4311
+ "keywords": [
4312
+ "storage",
4313
+ "raid-controller",
4314
+ "hp",
4315
+ "hpssa",
4316
+ "array"
4317
+ ],
4318
+ "related_resources": {
4319
+ "integrations": {
4320
+ "list": []
4321
+ }
4322
+ },
4323
+ "info_provided_to_referring_integrations": {
4324
+ "description": ""
4325
+ },
4326
+ "most_popular": false
4327
+ },
4328
+ "overview": "# HPE Smart Arrays\n\nPlugin: go.d.plugin\nModule: hpssa\n\n## Overview\n\nMonitors the health of HPE Smart Arrays by tracking the status of controllers, arrays, logical and physical drives in your storage system.\nIt relies on the `ssacli` 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- `ssacli ctrl all show config detail`\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",
4329
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Install ssacli\n\nSee [official installation instructions](https://support.hpe.com/connect/s/softwaredetails?language=en_US&collectionId=MTX-0cb3f808e2514d3d).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/ssacli.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/ssacli.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 | ssacli 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: hpssa\n update_every: 5 # Collect HPE Smart Array statistics every 5 seconds\n\n```\n",
4330
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `hpssa` 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 hpssa\n ```\n\n",
4331
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
4332
+ "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| slot | Slot number |\n| model | Controller model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.controller_status | ok, nok | status |\n| hpssa.controller_temperature | temperature | Celsius |\n| hpssa.controller_cache_module_presence_status | present, not_present | status |\n| hpssa.controller_cache_module_status | ok, nok | status |\n| hpssa.controller_cache_module_temperature | temperature | Celsius |\n| hpssa.controller_cache_module_battery status | ok, nok | status |\n\n### Per array\n\nThese metrics refer to the Array.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id |\n| interface_type | Array interface type (e.g. SATA) |\n| array_type | Array type (e.g. Data) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.array_status | ok, nok | status |\n\n### Per logical drive\n\nThese metrics refer to the Logical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id |\n| logical_drive_id | Logical Drive id (number) |\n| disk_name | Disk name (e.g. /dev/sda) |\n| drive_type | Drive type (e.g. Data) |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.logical_drive_status | ok, nok | status |\n\n### Per physical drive\n\nThese metrics refer to the Physical Drive.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| slot | Slot number |\n| array_id | Array id or \"na\" if unassigned |\n| logical_drive_id | Logical Drive id or \"na\" if unassigned |\n| location | Drive location in port:box:bay format (e.g. 1I:1:1) |\n| interface_type | Drive interface type (e.g. SATA) |\n| drive_type | Drive type (e.g. Data Drive, Unassigned Drive) |\n| model | Drive model |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.physical_drive_status | ok, nok | status |\n| hpssa.physical_drive_temperature | temperature | status |\n\n",
4333
+ "integration_type": "collector",
4334
+ "id": "go.d.plugin-hpssa-HPE_Smart_Arrays",
4335
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hpssa/metadata.yaml",
4336
+ "related_resources": ""
4337
+ },
4338
{
4339
"meta": {
4340
"id": "collector-go.d.plugin-httpcheck",
@@ -18633,44 +18673,6 @@
18673
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/go_expvar/metadata.yaml",
18674
"related_resources": ""
18675
},
18636
- {
18637
- "meta": {
18638
- "plugin_name": "python.d.plugin",
18639
- "module_name": "hpssa",
18640
- "monitored_instance": {
18641
- "name": "HP Smart Storage Arrays",
18642
- "link": "https://buy.hpe.com/us/en/software/server-management-software/server-management-software/smart-array-management-software/hpe-smart-storage-administrator/p/5409020",
18643
- "categories": [
18644
- "data-collection.storage-mount-points-and-filesystems"
18645
- ],
18646
- "icon_filename": "hp.svg"
18647
- },
18648
- "related_resources": {
18649
- "integrations": {
18650
- "list": []
18651
- }
18652
- },
18653
- "info_provided_to_referring_integrations": {
18654
- "description": ""
18655
- },
18656
- "keywords": [
18657
- "storage",
18658
- "hp",
18659
- "hpssa",
18660
- "array"
18661
- ],
18662
- "most_popular": false
18663
- },
18664
- "overview": "# HP Smart Storage Arrays\n\nPlugin: python.d.plugin\nModule: hpssa\n\n## Overview\n\nThis collector monitors HP Smart Storage Arrays metrics about operational statuses and temperatures.\n\nIt uses the command line tool `ssacli`. The exact command used is `sudo -n ssacli ctrl all show config detail`\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\nIf no configuration is provided, the collector will try to execute the `ssacli` binary.\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",
18665
- "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the hpssa collector\n\nThe `hpssa` collector is disabled by default. To enable it, use `edit-config` from the Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md), which is typically at `/etc/netdata`, to edit the `python.d.conf` file.\n\n```bash\ncd /etc/netdata # Replace this path with your Netdata config directory, if different\nsudo ./edit-config python.d.conf\n```\n\nChange the value of the `hpssa` setting to `yes`. Save the file and restart the Netdata Agent with `sudo systemctl restart netdata`, or the [appropriate method](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.\n\n\n#### Allow user netdata to execute `ssacli` as root.\n\nThis module uses `ssacli`, which can only be executed by root. It uses `sudo` and assumes that it is configured such that the `netdata` user can execute `ssacli` as root without a password.\n\n- Add to your `/etc/sudoers` file:\n\n`which ssacli` shows the full path to the binary.\n\n```bash\nnetdata ALL=(root) NOPASSWD: /path/to/ssacli\n```\n\n- Reset Netdata's systemd\n unit [CapabilityBoundingSet](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Capabilities) (Linux\n distributions with systemd)\n\nThe default CapabilityBoundingSet doesn't allow using `sudo`, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute `ssacli` using `sudo`.\n\nAs the `root` user, do the following:\n\n```cmd\nmkdir /etc/systemd/system/netdata.service.d\necho -e '[Service]\\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf\nsystemctl daemon-reload\nsystemctl restart netdata.service\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/hpssa.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 python.d/hpssa.conf\n```\n#### Options\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 5 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n| ssacli_path | Path to the `ssacli` command line utility. Configure this if `ssacli` is not in the $PATH | | no |\n| use_sudo | Whether or not to use `sudo` to execute `ssacli` | True | no |\n\n#### Examples\n\n##### Local simple config\n\nA basic configuration, specyfing the path to `ssacli`\n\n```yaml\nlocal:\n ssacli_path: /usr/sbin/ssacli\n\n```\n",
18666
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `hpssa` collector, run the `python.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 `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin hpssa debug trace\n ```\n\n",
18667
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
18668
- "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 HP Smart Storage Arrays instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| hpssa.ctrl_status | ctrl_{adapter slot}_status, cache_{adapter slot}_status, battery_{adapter slot}_status per adapter | Status |\n| hpssa.ctrl_temperature | ctrl_{adapter slot}_temperature, cache_{adapter slot}_temperature per adapter | Celsius |\n| hpssa.ld_status | a dimension per logical drive | Status |\n| hpssa.pd_status | a dimension per physical drive | Status |\n| hpssa.pd_temperature | a dimension per physical drive | Celsius |\n\n",
18669
- "integration_type": "collector",
18670
- "id": "python.d.plugin-hpssa-HP_Smart_Storage_Arrays",
18671
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/hpssa/metadata.yaml",
18672
- "related_resources": ""
18673
- },
18676
{
18677
"meta": {
18678
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -1009,7 +1009,7 @@ If you don't see the app/service you'd like to monitor in this list:
1009
1010
- [HDSentinel](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/hdsentinel.md)
1011
1012
-- [HP Smart Storage Arrays](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/hpssa/integrations/hp_smart_storage_arrays.md)
1012
+- [HPE Smart Arrays](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hpssa/integrations/hpe_smart_arrays.md)
1013
1014
- [Hadoop Distributed File System (HDFS)](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/hdfs/integrations/hadoop_distributed_file_system_hdfs.md)
1015
src/go/collectors/go.d.plugin/modules/hpssa/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/hpe_smart_arrays.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/hpssa/integrations/hpe_smart_arrays.md
new
+236
@@ -0,0 +1,236 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/hpssa/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/hpssa/metadata.yaml"
4
+sidebar_label: "HPE Smart Arrays"
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
+# HPE Smart Arrays
12
+
13
+
14
+<img src="https://netdata.cloud/img/hp.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: hpssa
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+Monitors the health of HPE Smart Arrays by tracking the status of controllers, arrays, logical and physical drives in your storage system.
25
+It relies on the `ssacli` 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
+- `ssacli ctrl all show config detail`
31
+
32
+
33
+
34
+
35
+This collector is supported on all platforms.
36
+
37
+This collector only supports collecting metrics from a single instance of this integration.
38
+
39
+
40
+### Default Behavior
41
+
42
+#### Auto-Detection
43
+
44
+This integration doesn't support auto-detection.
45
+
46
+#### Limits
47
+
48
+The default configuration for this integration does not impose any limits on data collection.
49
+
50
+#### Performance Impact
51
+
52
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
53
+
54
+
55
+## Metrics
56
+
57
+Metrics grouped by *scope*.
58
+
59
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
60
+
61
+
62
+
63
+### Per controller
64
+
65
+These metrics refer to the Controller.
66
+
67
+Labels:
68
+
69
+| Label | Description |
70
+|:-----------|:----------------|
71
+| slot | Slot number |
72
+| model | Controller model |
73
+
74
+Metrics:
75
+
76
+| Metric | Dimensions | Unit |
77
+|:------|:----------|:----|
78
+| hpssa.controller_status | ok, nok | status |
79
+| hpssa.controller_temperature | temperature | Celsius |
80
+| hpssa.controller_cache_module_presence_status | present, not_present | status |
81
+| hpssa.controller_cache_module_status | ok, nok | status |
82
+| hpssa.controller_cache_module_temperature | temperature | Celsius |
83
+| hpssa.controller_cache_module_battery status | ok, nok | status |
84
+
85
+### Per array
86
+
87
+These metrics refer to the Array.
88
+
89
+Labels:
90
+
91
+| Label | Description |
92
+|:-----------|:----------------|
93
+| slot | Slot number |
94
+| array_id | Array id |
95
+| interface_type | Array interface type (e.g. SATA) |
96
+| array_type | Array type (e.g. Data) |
97
+
98
+Metrics:
99
+
100
+| Metric | Dimensions | Unit |
101
+|:------|:----------|:----|
102
+| hpssa.array_status | ok, nok | status |
103
+
104
+### Per logical drive
105
+
106
+These metrics refer to the Logical Drive.
107
+
108
+Labels:
109
+
110
+| Label | Description |
111
+|:-----------|:----------------|
112
+| slot | Slot number |
113
+| array_id | Array id |
114
+| logical_drive_id | Logical Drive id (number) |
115
+| disk_name | Disk name (e.g. /dev/sda) |
116
+| drive_type | Drive type (e.g. Data) |
117
+
118
+Metrics:
119
+
120
+| Metric | Dimensions | Unit |
121
+|:------|:----------|:----|
122
+| hpssa.logical_drive_status | ok, nok | status |
123
+
124
+### Per physical drive
125
+
126
+These metrics refer to the Physical Drive.
127
+
128
+Labels:
129
+
130
+| Label | Description |
131
+|:-----------|:----------------|
132
+| slot | Slot number |
133
+| array_id | Array id or "na" if unassigned |
134
+| logical_drive_id | Logical Drive id or "na" if unassigned |
135
+| location | Drive location in port:box:bay format (e.g. 1I:1:1) |
136
+| interface_type | Drive interface type (e.g. SATA) |
137
+| drive_type | Drive type (e.g. Data Drive, Unassigned Drive) |
138
+| model | Drive model |
139
+
140
+Metrics:
141
+
142
+| Metric | Dimensions | Unit |
143
+|:------|:----------|:----|
144
+| hpssa.physical_drive_status | ok, nok | status |
145
+| hpssa.physical_drive_temperature | temperature | status |
146
+
147
+
148
+
149
+## Alerts
150
+
151
+There are no alerts configured by default for this integration.
152
+
153
+
154
+## Setup
155
+
156
+### Prerequisites
157
+
158
+#### Install ssacli
159
+
160
+See [official installation instructions](https://support.hpe.com/connect/s/softwaredetails?language=en_US&collectionId=MTX-0cb3f808e2514d3d).
161
+
162
+
163
+
164
+### Configuration
165
+
166
+#### File
167
+
168
+The configuration file name for this integration is `go.d/ssacli.conf`.
169
+
170
+
171
+You can edit the configuration file using the `edit-config` script from the
172
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
173
+
174
+```bash
175
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
176
+sudo ./edit-config go.d/ssacli.conf
177
+```
178
+#### Options
179
+
180
+The following options can be defined globally: update_every.
181
+
182
+
183
+<details><summary>Config options</summary>
184
+
185
+| Name | Description | Default | Required |
186
+|:----|:-----------|:-------|:--------:|
187
+| update_every | Data collection frequency. | 10 | no |
188
+| timeout | ssacli binary execution timeout. | 2 | no |
189
+
190
+</details>
191
+
192
+#### Examples
193
+
194
+##### Custom update_every
195
+
196
+Allows you to override the default data collection interval.
197
+
198
+<details><summary>Config</summary>
199
+
200
+```yaml
201
+jobs:
202
+ - name: hpssa
203
+ update_every: 5 # Collect HPE Smart Array statistics every 5 seconds
204
+
205
+```
206
+</details>
207
+
208
+
209
+
210
+## Troubleshooting
211
+
212
+### Debug Mode
213
+
214
+To troubleshoot issues with the `hpssa` collector, run the `go.d.plugin` with the debug option enabled. The output
215
+should give you clues as to why the collector isn't working.
216
+
217
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
218
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
219
+
220
+ ```bash
221
+ cd /usr/libexec/netdata/plugins.d/
222
+ ```
223
+
224
+- Switch to the `netdata` user.
225
+
226
+ ```bash
227
+ sudo -u netdata -s
228
+ ```
229
+
230
+- Run the `go.d.plugin` to debug the collector:
231
+
232
+ ```bash
233
+ ./go.d.plugin -d -m hpssa
234
+ ```
235
+
236
+