Regenerate integrations.js (#17560)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 30, 2024 at 19:06 UTC
a03b52a4dede68d5a5471c493e1b3a6bc53e80ff
6 files changed
+263
-2
integrations/cloud-authentication/integrations/okta_sso.md
+4
@@ -44,6 +44,10 @@ Steps needed to be done on Okta Admin Portal:
44
- **Client ID** you can get it from **General** tab on application you configured on Okta
45
- **Client Secret** you can get it from **General** tab on application you configured on Okta
46
47
+### Supported features
48
+* SP-initiated SSO (Single Sign-On)
49
+* IdP-initiated SSO
50
+
51
### SP-initiated SSO
52
53
If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).
integrations/integrations.js
+40
-1
@@ -15834,6 +15834,45 @@ export const integrations = [
15834
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/sensors/metadata.yaml",
15835
"related_resources": ""
15836
},
15837
+ {
15838
+ "meta": {
15839
+ "id": "collector-go.d.plugin-smartctl",
15840
+ "plugin_name": "go.d.plugin",
15841
+ "module_name": "smartctl",
15842
+ "monitored_instance": {
15843
+ "name": "S.M.A.R.T.",
15844
+ "link": "https://linux.die.net/man/8/smartd",
15845
+ "icon_filename": "smart.png",
15846
+ "categories": [
15847
+ "data-collection.hardware-devices-and-sensors"
15848
+ ]
15849
+ },
15850
+ "keywords": [
15851
+ "smart",
15852
+ "S.M.A.R.T.",
15853
+ "SCSI devices",
15854
+ "ATA devices"
15855
+ ],
15856
+ "related_resources": {
15857
+ "integrations": {
15858
+ "list": []
15859
+ }
15860
+ },
15861
+ "info_provided_to_referring_integrations": {
15862
+ "description": ""
15863
+ },
15864
+ "most_popular": false
15865
+ },
15866
+ "overview": "# S.M.A.R.T.\n\nPlugin: go.d.plugin\nModule: smartctl\n\n## Overview\n\nThis collector monitors the health status of storage devices by analyzing S.M.A.R.T. (Self-Monitoring, Analysis, and Reporting Technology) counters.\nIt relies on the [`smartctl`](https://linux.die.net/man/8/smartctl) 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- `smartctl --json --scan`\n- `smartctl --json --all {deviceName} --device {deviceType} --nocheck {powerMode}`\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",
15867
+ "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/smartctl.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/smartctl.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 | interval for updating Netdata charts, measured in seconds. Collector might use cached data if less than **Devices poll interval**. | 10 | no |\n| timeout | smartctl binary execution timeout. | 5 | no |\n| scan_every | interval for discovering new devices using `smartctl --scan`, measured in seconds. | 900 | no |\n| poll_devices_every | interval for gathering data for every device, measured in seconds. Data is cached for this interval. | 300 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom devices poll interval\n\nAllows you to override the default devices poll interval (data collection).\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: smartctl\n devices_poll_interval: 60 # Collect S.M.A.R.T statistics every 60 seconds\n\n```\n{% /details %}\n",
15868
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `smartctl` 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 smartctl\n ```\n\n",
15869
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15870
+ "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 Storage Device.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| device_name | Device name |\n| device_type | Device type |\n| model_name | Model name |\n| serial_number | Serial number |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| smartctl.device_smart_status | passed, failed | status |\n| smartctl.device_ata_smart_error_log_count | error_log | logs |\n| smartctl.device_power_on_time | power_on_time | seconds |\n| smartctl.device_temperature | temperature | Celsius |\n| smartctl.device_power_cycles_count | power | cycles |\n| smartctl.device_smart_attr_{attribute_name} | {attribute_name} | {attribute_unit} |\n| smartctl.device_smart_attr_{attribute_name}_normalized | {attribute_name} | value |\n\n",
15871
+ "integration_type": "collector",
15872
+ "id": "go.d.plugin-smartctl-S.M.A.R.T.",
15873
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/smartctl/metadata.yaml",
15874
+ "related_resources": ""
15875
+ },
15876
{
15877
"meta": {
15878
"id": "collector-go.d.plugin-snmp",
@@ -22280,7 +22319,7 @@ export const integrations = [
22319
"okta-sso"
22320
],
22321
"overview": "# Okta SSO\n\nIntegrate your organization's Okta account with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22283
- "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22322
+ "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### Supported features\n* SP-initiated SSO (Single Sign-On)\n* IdP-initiated SSO\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22323
"integration_type": "authentication",
22324
"edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22325
"troubleshooting": ""
integrations/integrations.json
+40
-1
@@ -15832,6 +15832,45 @@
15832
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/sensors/metadata.yaml",
15833
"related_resources": ""
15834
},
15835
+ {
15836
+ "meta": {
15837
+ "id": "collector-go.d.plugin-smartctl",
15838
+ "plugin_name": "go.d.plugin",
15839
+ "module_name": "smartctl",
15840
+ "monitored_instance": {
15841
+ "name": "S.M.A.R.T.",
15842
+ "link": "https://linux.die.net/man/8/smartd",
15843
+ "icon_filename": "smart.png",
15844
+ "categories": [
15845
+ "data-collection.hardware-devices-and-sensors"
15846
+ ]
15847
+ },
15848
+ "keywords": [
15849
+ "smart",
15850
+ "S.M.A.R.T.",
15851
+ "SCSI devices",
15852
+ "ATA devices"
15853
+ ],
15854
+ "related_resources": {
15855
+ "integrations": {
15856
+ "list": []
15857
+ }
15858
+ },
15859
+ "info_provided_to_referring_integrations": {
15860
+ "description": ""
15861
+ },
15862
+ "most_popular": false
15863
+ },
15864
+ "overview": "# S.M.A.R.T.\n\nPlugin: go.d.plugin\nModule: smartctl\n\n## Overview\n\nThis collector monitors the health status of storage devices by analyzing S.M.A.R.T. (Self-Monitoring, Analysis, and Reporting Technology) counters.\nIt relies on the [`smartctl`](https://linux.die.net/man/8/smartctl) 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- `smartctl --json --scan`\n- `smartctl --json --all {deviceName} --device {deviceType} --nocheck {powerMode}`\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",
15865
+ "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/smartctl.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/smartctl.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 | interval for updating Netdata charts, measured in seconds. Collector might use cached data if less than **Devices poll interval**. | 10 | no |\n| timeout | smartctl binary execution timeout. | 5 | no |\n| scan_every | interval for discovering new devices using `smartctl --scan`, measured in seconds. | 900 | no |\n| poll_devices_every | interval for gathering data for every device, measured in seconds. Data is cached for this interval. | 300 | no |\n\n#### Examples\n\n##### Custom devices poll interval\n\nAllows you to override the default devices poll interval (data collection).\n\n```yaml\njobs:\n - name: smartctl\n devices_poll_interval: 60 # Collect S.M.A.R.T statistics every 60 seconds\n\n```\n",
15866
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `smartctl` 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 smartctl\n ```\n\n",
15867
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15868
+ "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 Storage Device.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| device_name | Device name |\n| device_type | Device type |\n| model_name | Model name |\n| serial_number | Serial number |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| smartctl.device_smart_status | passed, failed | status |\n| smartctl.device_ata_smart_error_log_count | error_log | logs |\n| smartctl.device_power_on_time | power_on_time | seconds |\n| smartctl.device_temperature | temperature | Celsius |\n| smartctl.device_power_cycles_count | power | cycles |\n| smartctl.device_smart_attr_{attribute_name} | {attribute_name} | {attribute_unit} |\n| smartctl.device_smart_attr_{attribute_name}_normalized | {attribute_name} | value |\n\n",
15869
+ "integration_type": "collector",
15870
+ "id": "go.d.plugin-smartctl-S.M.A.R.T.",
15871
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/smartctl/metadata.yaml",
15872
+ "related_resources": ""
15873
+ },
15874
{
15875
"meta": {
15876
"id": "collector-go.d.plugin-snmp",
@@ -22278,7 +22317,7 @@
22317
"okta-sso"
22318
],
22319
"overview": "# Okta SSO\n\nIntegrate your organization's Okta account with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22281
- "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22320
+ "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### Supported features\n* SP-initiated SSO (Single Sign-On)\n* IdP-initiated SSO\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22321
"integration_type": "authentication",
22322
"edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22323
"troubleshooting": ""
src/collectors/COLLECTORS.md
+2
@@ -517,6 +517,8 @@ If you don't see the app/service you'd like to monitor in this list:
517
518
- [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)
519
520
+- [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)
521
+
522
- [ServerTech](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/servertech.md)
523
524
- [Siemens S7 PLC](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/siemens_s7_plc.md)
src/go/collectors/go.d.plugin/modules/smartctl/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/s.m.a.r.t..md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/smartctl/integrations/s.m.a.r.t..md
new
+176
@@ -0,0 +1,176 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/smartctl/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/smartctl/metadata.yaml"
4
+sidebar_label: "S.M.A.R.T."
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
+# S.M.A.R.T.
12
+
13
+
14
+<img src="https://netdata.cloud/img/smart.png" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: smartctl
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors the health status of storage devices by analyzing S.M.A.R.T. (Self-Monitoring, Analysis, and Reporting Technology) counters.
25
+It relies on the [`smartctl`](https://linux.die.net/man/8/smartctl) 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
+- `smartctl --json --scan`
31
+- `smartctl --json --all {deviceName} --device {deviceType} --nocheck {powerMode}`
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 Storage Device.
67
+
68
+Labels:
69
+
70
+| Label | Description |
71
+|:-----------|:----------------|
72
+| device_name | Device name |
73
+| device_type | Device type |
74
+| model_name | Model name |
75
+| serial_number | Serial number |
76
+
77
+Metrics:
78
+
79
+| Metric | Dimensions | Unit |
80
+|:------|:----------|:----|
81
+| smartctl.device_smart_status | passed, failed | status |
82
+| smartctl.device_ata_smart_error_log_count | error_log | logs |
83
+| smartctl.device_power_on_time | power_on_time | seconds |
84
+| smartctl.device_temperature | temperature | Celsius |
85
+| smartctl.device_power_cycles_count | power | cycles |
86
+| smartctl.device_smart_attr_{attribute_name} | {attribute_name} | {attribute_unit} |
87
+| smartctl.device_smart_attr_{attribute_name}_normalized | {attribute_name} | value |
88
+
89
+
90
+
91
+## Alerts
92
+
93
+There are no alerts configured by default for this integration.
94
+
95
+
96
+## Setup
97
+
98
+### Prerequisites
99
+
100
+No action required.
101
+
102
+### Configuration
103
+
104
+#### File
105
+
106
+The configuration file name for this integration is `go.d/smartctl.conf`.
107
+
108
+
109
+You can edit the configuration file using the `edit-config` script from the
110
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
111
+
112
+```bash
113
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
114
+sudo ./edit-config go.d/smartctl.conf
115
+```
116
+#### Options
117
+
118
+The following options can be defined globally: update_every.
119
+
120
+
121
+<details><summary>Config options</summary>
122
+
123
+| Name | Description | Default | Required |
124
+|:----|:-----------|:-------|:--------:|
125
+| update_every | interval for updating Netdata charts, measured in seconds. Collector might use cached data if less than **Devices poll interval**. | 10 | no |
126
+| timeout | smartctl binary execution timeout. | 5 | no |
127
+| scan_every | interval for discovering new devices using `smartctl --scan`, measured in seconds. | 900 | no |
128
+| poll_devices_every | interval for gathering data for every device, measured in seconds. Data is cached for this interval. | 300 | no |
129
+
130
+</details>
131
+
132
+#### Examples
133
+
134
+##### Custom devices poll interval
135
+
136
+Allows you to override the default devices poll interval (data collection).
137
+
138
+<details><summary>Config</summary>
139
+
140
+```yaml
141
+jobs:
142
+ - name: smartctl
143
+ devices_poll_interval: 60 # Collect S.M.A.R.T statistics every 60 seconds
144
+
145
+```
146
+</details>
147
+
148
+
149
+
150
+## Troubleshooting
151
+
152
+### Debug Mode
153
+
154
+To troubleshoot issues with the `smartctl` collector, run the `go.d.plugin` with the debug option enabled. The output
155
+should give you clues as to why the collector isn't working.
156
+
157
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
158
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
159
+
160
+ ```bash
161
+ cd /usr/libexec/netdata/plugins.d/
162
+ ```
163
+
164
+- Switch to the `netdata` user.
165
+
166
+ ```bash
167
+ sudo -u netdata -s
168
+ ```
169
+
170
+- Run the `go.d.plugin` to debug the collector:
171
+
172
+ ```bash
173
+ ./go.d.plugin -d -m smartctl
174
+ ```
175
+
176
+