diff options
author | Netdata bot <43409846+netdatabot@users.noreply.github.com> | 2024-04-30 19:06:01 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-30 19:06:01 +0300 |
commit | a03b52a4dede68d5a5471c493e1b3a6bc53e80ff (patch) | |
tree | c8ee2a3d839627242e2d2540bbb17972d9afa6cb /src | |
parent | e1c4f7fec367a610c9c8beea1789c51c6434d51a (diff) |
Regenerate integrations.js (#17560)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/collectors/COLLECTORS.md | 2 | ||||
l--------- | src/go/collectors/go.d.plugin/modules/smartctl/README.md | 1 | ||||
-rw-r--r-- | src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md | 176 |
3 files changed, 179 insertions, 0 deletions
diff --git a/src/collectors/COLLECTORS.md b/src/collectors/COLLECTORS.md index f922e335ee..4eaf6f06dc 100644 --- a/src/collectors/COLLECTORS.md +++ b/src/collectors/COLLECTORS.md @@ -517,6 +517,8 @@ If you don't see the app/service you'd like to monitor in this list: - [S.M.A.R.T.](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/smartd_log/integrations/s.m.a.r.t..md) +- [S.M.A.R.T.](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md) + - [ServerTech](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/servertech.md) - [Siemens S7 PLC](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/siemens_s7_plc.md) diff --git a/src/go/collectors/go.d.plugin/modules/smartctl/README.md b/src/go/collectors/go.d.plugin/modules/smartctl/README.md new file mode 120000 index 0000000000..63aad6c850 --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/smartctl/README.md @@ -0,0 +1 @@ +integrations/s.m.a.r.t..md
\ No newline at end of file diff --git a/src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md b/src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md new file mode 100644 index 0000000000..548ee423ae --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md @@ -0,0 +1,176 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/smartctl/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/smartctl/metadata.yaml" +sidebar_label: "S.M.A.R.T." +learn_status: "Published" +learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors" +most_popular: False +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" +endmeta--> + +# S.M.A.R.T. + + +<img src="https://netdata.cloud/img/smart.png" width="150"/> + + +Plugin: go.d.plugin +Module: smartctl + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Overview + +This collector monitors the health status of storage devices by analyzing S.M.A.R.T. (Self-Monitoring, Analysis, and Reporting Technology) counters. +It relies on the [`smartctl`](https://linux.die.net/man/8/smartctl) 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: +- `smartctl --json --scan` +- `smartctl --json --all {deviceName} --device {deviceType} --nocheck {powerMode}` + + + + +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 Storage Device. + +Labels: + +| Label | Description | +|:-----------|:----------------| +| device_name | Device name | +| device_type | Device type | +| model_name | Model name | +| serial_number | Serial number | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| smartctl.device_smart_status | passed, failed | status | +| smartctl.device_ata_smart_error_log_count | error_log | logs | +| smartctl.device_power_on_time | power_on_time | seconds | +| smartctl.device_temperature | temperature | Celsius | +| smartctl.device_power_cycles_count | power | cycles | +| smartctl.device_smart_attr_{attribute_name} | {attribute_name} | {attribute_unit} | +| smartctl.device_smart_attr_{attribute_name}_normalized | {attribute_name} | value | + + + +## 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/smartctl.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/smartctl.conf +``` +#### Options + +The following options can be defined globally: update_every. + + +<details><summary>Config options</summary> + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| update_every | interval for updating Netdata charts, measured in seconds. Collector might use cached data if less than **Devices poll interval**. | 10 | no | +| timeout | smartctl binary execution timeout. | 5 | no | +| scan_every | interval for discovering new devices using `smartctl --scan`, measured in seconds. | 900 | no | +| poll_devices_every | interval for gathering data for every device, measured in seconds. Data is cached for this interval. | 300 | no | + +</details> + +#### Examples + +##### Custom devices poll interval + +Allows you to override the default devices poll interval (data collection). + +<details><summary>Config</summary> + +```yaml +jobs: + - name: smartctl + devices_poll_interval: 60 # Collect S.M.A.R.T statistics every 60 seconds + +``` +</details> + + + +## Troubleshooting + +### Debug Mode + +To troubleshoot issues with the `smartctl` 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 smartctl + ``` + + |