Regenerate integrations.js (#18592)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Sep 21, 2024 at 13:53 UTC
3a5af03cd634fcb24073977c4cc3ff6536a890bf
6 files changed
+236
-239
integrations/integrations.js
+7
-6
@@ -16490,7 +16490,7 @@ export const integrations = [
16490
"plugin_name": "go.d.plugin",
16491
"module_name": "sensors",
16492
"monitored_instance": {
16493
- "name": "Linux Sensors (lm-sensors)",
16493
+ "name": "Linux Sensors",
16494
"link": "https://hwmon.wiki.kernel.org/lm_sensors",
16495
"icon_filename": "microchip.svg",
16496
"categories": [
@@ -16505,7 +16505,8 @@ export const integrations = [
16505
"power",
16506
"fan",
16507
"energy",
16508
- "humidity"
16508
+ "humidity",
16509
+ "intrusion"
16510
],
16511
"related_resources": {
16512
"integrations": {
@@ -16517,13 +16518,13 @@ export const integrations = [
16518
},
16519
"most_popular": false
16520
},
16520
- "overview": "# Linux Sensors (lm-sensors)\n\nPlugin: go.d.plugin\nModule: sensors\n\n## Overview\n\nThis collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sensors](https://linux.die.net/man/1/sensors) binary or [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface).\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\nThe following type of sensors are auto-detected:\n\n- temperature\n- fan\n- voltage\n- current\n- power\n- energy\n- humidity\n\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",
16521
- "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/sensors.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/sensors.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| binary_path | Path to the `sensors` binary. If left empty or if the binary is not found, [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) will be used to collect sensor statistics. | /usr/bin/sensors | yes |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom binary path\n\nThe executable is not in the directories specified in the PATH environment variable.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: sensors\n binary_path: /usr/local/sbin/sensors\n\n```\n{% /details %}\n##### Use sysfs instead of sensors\n\nSet `binary_path` to an empty string to use sysfs.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: sensors\n binary_path: \"\"\n\n```\n{% /details %}\n",
16521
+ "overview": "# Linux Sensors\n\nPlugin: go.d.plugin\nModule: sensors\n\n## Overview\n\nThis collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface.\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\nThe following type of sensors are auto-detected:\n\n- temperature\n- voltage\n- fan\n- current\n- power\n- energy\n- humidity\n- intrusion\n\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",
16522
+ "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/sensors.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/sensors.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: sensors\n update_every: 5 # Collect sensors statistics every 5 seconds\n\n```\n{% /details %}\n",
16523
"troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `sensors` 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 sensors\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `sensors` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep sensors\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep sensors /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep sensors\n```\n\n",
16524
"alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16524
- "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 sensor\n\nThese metrics refer to the sensor.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| chip | The hardware component responsible for the sensor monitoring. |\n| feature | The specific sensor or monitoring point provided by the chip. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| sensors.sensor_temperature | temperature | Celsius |\n| sensors.sensor_voltage | voltage | Volts |\n| sensors.sensor_current | current | Amperes |\n| sensors.sensor_power | power | Watts |\n| sensors.sensor_fan_speed | fan | RPM |\n| sensors.sensor_energy | energy | Joules |\n| sensors.sensor_humidity | humidity | percent |\n| sensors.sensor_intrusion | alarm_clear, alarm_triggered | status |\n\n",
16525
+ "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 sensor\n\nThese metrics refer to the system sensor.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| chip | The path to the sensor's chip device, excluding the /sys/devices prefix. This provides a unique identifier for the physical hardware component. |\n| chip_id | A unique identifier for the sensor's chip, formatted as `chipName-busType-hash`. |\n| sensor | The name of the specific sensor within the chip device. This provides a direct identifier for the individual measurement point. |\n| label | A label provided by the kernel driver to indicate the intended use or purpose of the sensor. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| sensors.chip_sensor_temperature | input | Celsius |\n| sensors.chip_sensor_temperature_alarm | clear, triggered | status |\n| sensors.chip_sensor_voltage | input | Volts |\n| sensors.chip_sensor_voltage_average | average | Volts |\n| sensors.chip_sensor_voltage_alarm | clear, triggered | status |\n| sensors.chip_sensor_fan | input | RPM |\n| sensors.chip_sensor_fan_alarm | clear, triggered | status |\n| sensors.chip_sensor_current | input | Amperes |\n| sensors.chip_sensor_current_average | average | Amperes |\n| sensors.chip_sensor_current_alarm | clear, triggered | status |\n| sensors.chip_sensor_power | input | Watts |\n| sensors.chip_sensor_power_average | average | Watts |\n| sensors.chip_sensor_power_alarm | clear, triggered | status |\n| sensors.chip_sensor_energy | input | Joules |\n| sensors.chip_sensor_humidity | input | percent |\n| sensors.chip_sensor_intrusion_alarm | clear, triggered | status |\n\n",
16526
"integration_type": "collector",
16526
- "id": "go.d.plugin-sensors-Linux_Sensors_(lm-sensors)",
16527
+ "id": "go.d.plugin-sensors-Linux_Sensors",
16528
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/sensors/metadata.yaml",
16529
"related_resources": ""
16530
},
integrations/integrations.json
+7
-6
@@ -16488,7 +16488,7 @@
16488
"plugin_name": "go.d.plugin",
16489
"module_name": "sensors",
16490
"monitored_instance": {
16491
- "name": "Linux Sensors (lm-sensors)",
16491
+ "name": "Linux Sensors",
16492
"link": "https://hwmon.wiki.kernel.org/lm_sensors",
16493
"icon_filename": "microchip.svg",
16494
"categories": [
@@ -16503,7 +16503,8 @@
16503
"power",
16504
"fan",
16505
"energy",
16506
- "humidity"
16506
+ "humidity",
16507
+ "intrusion"
16508
],
16509
"related_resources": {
16510
"integrations": {
@@ -16515,13 +16516,13 @@
16516
},
16517
"most_popular": false
16518
},
16518
- "overview": "# Linux Sensors (lm-sensors)\n\nPlugin: go.d.plugin\nModule: sensors\n\n## Overview\n\nThis collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sensors](https://linux.die.net/man/1/sensors) binary or [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface).\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\nThe following type of sensors are auto-detected:\n\n- temperature\n- fan\n- voltage\n- current\n- power\n- energy\n- humidity\n\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",
16519
- "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/sensors.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/sensors.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| binary_path | Path to the `sensors` binary. If left empty or if the binary is not found, [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) will be used to collect sensor statistics. | /usr/bin/sensors | yes |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n\n#### Examples\n\n##### Custom binary path\n\nThe executable is not in the directories specified in the PATH environment variable.\n\n```yaml\njobs:\n - name: sensors\n binary_path: /usr/local/sbin/sensors\n\n```\n##### Use sysfs instead of sensors\n\nSet `binary_path` to an empty string to use sysfs.\n\n```yaml\njobs:\n - name: sensors\n binary_path: \"\"\n\n```\n",
16519
+ "overview": "# Linux Sensors\n\nPlugin: go.d.plugin\nModule: sensors\n\n## Overview\n\nThis collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface.\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\nThe following type of sensors are auto-detected:\n\n- temperature\n- voltage\n- fan\n- current\n- power\n- energy\n- humidity\n- intrusion\n\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",
16520
+ "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/sensors.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/sensors.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\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: sensors\n update_every: 5 # Collect sensors statistics every 5 seconds\n\n```\n",
16521
"troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `sensors` 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 sensors\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `sensors` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep sensors\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep sensors /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep sensors\n```\n\n",
16522
"alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16522
- "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 sensor\n\nThese metrics refer to the sensor.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| chip | The hardware component responsible for the sensor monitoring. |\n| feature | The specific sensor or monitoring point provided by the chip. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| sensors.sensor_temperature | temperature | Celsius |\n| sensors.sensor_voltage | voltage | Volts |\n| sensors.sensor_current | current | Amperes |\n| sensors.sensor_power | power | Watts |\n| sensors.sensor_fan_speed | fan | RPM |\n| sensors.sensor_energy | energy | Joules |\n| sensors.sensor_humidity | humidity | percent |\n| sensors.sensor_intrusion | alarm_clear, alarm_triggered | status |\n\n",
16523
+ "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 sensor\n\nThese metrics refer to the system sensor.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| chip | The path to the sensor's chip device, excluding the /sys/devices prefix. This provides a unique identifier for the physical hardware component. |\n| chip_id | A unique identifier for the sensor's chip, formatted as `chipName-busType-hash`. |\n| sensor | The name of the specific sensor within the chip device. This provides a direct identifier for the individual measurement point. |\n| label | A label provided by the kernel driver to indicate the intended use or purpose of the sensor. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| sensors.chip_sensor_temperature | input | Celsius |\n| sensors.chip_sensor_temperature_alarm | clear, triggered | status |\n| sensors.chip_sensor_voltage | input | Volts |\n| sensors.chip_sensor_voltage_average | average | Volts |\n| sensors.chip_sensor_voltage_alarm | clear, triggered | status |\n| sensors.chip_sensor_fan | input | RPM |\n| sensors.chip_sensor_fan_alarm | clear, triggered | status |\n| sensors.chip_sensor_current | input | Amperes |\n| sensors.chip_sensor_current_average | average | Amperes |\n| sensors.chip_sensor_current_alarm | clear, triggered | status |\n| sensors.chip_sensor_power | input | Watts |\n| sensors.chip_sensor_power_average | average | Watts |\n| sensors.chip_sensor_power_alarm | clear, triggered | status |\n| sensors.chip_sensor_energy | input | Joules |\n| sensors.chip_sensor_humidity | input | percent |\n| sensors.chip_sensor_intrusion_alarm | clear, triggered | status |\n\n",
16524
"integration_type": "collector",
16524
- "id": "go.d.plugin-sensors-Linux_Sensors_(lm-sensors)",
16525
+ "id": "go.d.plugin-sensors-Linux_Sensors",
16526
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/sensors/metadata.yaml",
16527
"related_resources": ""
16528
},
src/collectors/COLLECTORS.md
+1
-1
@@ -485,7 +485,7 @@ If you don't see the app/service you'd like to monitor in this list:
485
486
- [Intelligent Platform Management Interface (IPMI)](https://github.com/netdata/netdata/blob/master/src/collectors/freeipmi.plugin/integrations/intelligent_platform_management_interface_ipmi.md)
487
488
-- [Linux Sensors (lm-sensors)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/sensors/integrations/linux_sensors_lm-sensors.md)
488
+- [Linux Sensors](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/sensors/integrations/linux_sensors.md)
489
490
- [NVML](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/nvml.md)
491
src/go/plugin/go.d/modules/sensors/README.md
+1
-1
@@ -1 +1 @@
1
-integrations/linux_sensors_lm-sensors.md
\ No newline at end of file
1
+integrations/linux_sensors.md
\ No newline at end of file
src/go/plugin/go.d/modules/sensors/integrations/linux_sensors.md
new
+220
@@ -0,0 +1,220 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/sensors/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/sensors/metadata.yaml"
4
+sidebar_label: "Linux Sensors"
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
+# Linux Sensors
12
+
13
+
14
+<img src="https://netdata.cloud/img/microchip.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: sensors
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface.
25
+
26
+
27
+
28
+
29
+This collector is supported on all platforms.
30
+
31
+This collector only supports collecting metrics from a single instance of this integration.
32
+
33
+
34
+### Default Behavior
35
+
36
+#### Auto-Detection
37
+
38
+The following type of sensors are auto-detected:
39
+
40
+- temperature
41
+- voltage
42
+- fan
43
+- current
44
+- power
45
+- energy
46
+- humidity
47
+- intrusion
48
+
49
+
50
+#### Limits
51
+
52
+The default configuration for this integration does not impose any limits on data collection.
53
+
54
+#### Performance Impact
55
+
56
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
57
+
58
+
59
+## Metrics
60
+
61
+Metrics grouped by *scope*.
62
+
63
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
64
+
65
+
66
+
67
+### Per sensor
68
+
69
+These metrics refer to the system sensor.
70
+
71
+Labels:
72
+
73
+| Label | Description |
74
+|:-----------|:----------------|
75
+| chip | The path to the sensor's chip device, excluding the /sys/devices prefix. This provides a unique identifier for the physical hardware component. |
76
+| chip_id | A unique identifier for the sensor's chip, formatted as `chipName-busType-hash`. |
77
+| sensor | The name of the specific sensor within the chip device. This provides a direct identifier for the individual measurement point. |
78
+| label | A label provided by the kernel driver to indicate the intended use or purpose of the sensor. |
79
+
80
+Metrics:
81
+
82
+| Metric | Dimensions | Unit |
83
+|:------|:----------|:----|
84
+| sensors.chip_sensor_temperature | input | Celsius |
85
+| sensors.chip_sensor_temperature_alarm | clear, triggered | status |
86
+| sensors.chip_sensor_voltage | input | Volts |
87
+| sensors.chip_sensor_voltage_average | average | Volts |
88
+| sensors.chip_sensor_voltage_alarm | clear, triggered | status |
89
+| sensors.chip_sensor_fan | input | RPM |
90
+| sensors.chip_sensor_fan_alarm | clear, triggered | status |
91
+| sensors.chip_sensor_current | input | Amperes |
92
+| sensors.chip_sensor_current_average | average | Amperes |
93
+| sensors.chip_sensor_current_alarm | clear, triggered | status |
94
+| sensors.chip_sensor_power | input | Watts |
95
+| sensors.chip_sensor_power_average | average | Watts |
96
+| sensors.chip_sensor_power_alarm | clear, triggered | status |
97
+| sensors.chip_sensor_energy | input | Joules |
98
+| sensors.chip_sensor_humidity | input | percent |
99
+| sensors.chip_sensor_intrusion_alarm | clear, triggered | status |
100
+
101
+
102
+
103
+## Alerts
104
+
105
+There are no alerts configured by default for this integration.
106
+
107
+
108
+## Setup
109
+
110
+### Prerequisites
111
+
112
+No action required.
113
+
114
+### Configuration
115
+
116
+#### File
117
+
118
+The configuration file name for this integration is `go.d/sensors.conf`.
119
+
120
+
121
+You can edit the configuration file using the `edit-config` script from the
122
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
123
+
124
+```bash
125
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
126
+sudo ./edit-config go.d/sensors.conf
127
+```
128
+#### Options
129
+
130
+The following options can be defined globally: update_every.
131
+
132
+
133
+<details open><summary>Config options</summary>
134
+
135
+| Name | Description | Default | Required |
136
+|:----|:-----------|:-------|:--------:|
137
+| update_every | Data collection frequency. | 10 | no |
138
+
139
+</details>
140
+
141
+#### Examples
142
+
143
+##### Custom update_every
144
+
145
+Allows you to override the default data collection interval.
146
+
147
+<details open><summary>Config</summary>
148
+
149
+```yaml
150
+jobs:
151
+ - name: sensors
152
+ update_every: 5 # Collect sensors statistics every 5 seconds
153
+
154
+```
155
+</details>
156
+
157
+
158
+
159
+## Troubleshooting
160
+
161
+### Debug Mode
162
+
163
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
164
+
165
+To troubleshoot issues with the `sensors` collector, run the `go.d.plugin` with the debug option enabled. The output
166
+should give you clues as to why the collector isn't working.
167
+
168
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
169
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
170
+
171
+ ```bash
172
+ cd /usr/libexec/netdata/plugins.d/
173
+ ```
174
+
175
+- Switch to the `netdata` user.
176
+
177
+ ```bash
178
+ sudo -u netdata -s
179
+ ```
180
+
181
+- Run the `go.d.plugin` to debug the collector:
182
+
183
+ ```bash
184
+ ./go.d.plugin -d -m sensors
185
+ ```
186
+
187
+### Getting Logs
188
+
189
+If you're encountering problems with the `sensors` collector, follow these steps to retrieve logs and identify potential issues:
190
+
191
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
192
+- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
193
+
194
+#### System with systemd
195
+
196
+Use the following command to view logs generated since the last Netdata service restart:
197
+
198
+```bash
199
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep sensors
200
+```
201
+
202
+#### System without systemd
203
+
204
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
205
+
206
+```bash
207
+grep sensors /var/log/netdata/collector.log
208
+```
209
+
210
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
211
+
212
+#### Docker Container
213
+
214
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
215
+
216
+```bash
217
+docker logs netdata 2>&1 | grep sensors
218
+```
219
+
220
+
src/go/plugin/go.d/modules/sensors/integrations/linux_sensors_lm-sensors.md
-225
@@ -1,225 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/sensors/README.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/sensors/metadata.yaml"
4
-sidebar_label: "Linux Sensors (lm-sensors)"
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
-# Linux Sensors (lm-sensors)
12
-
13
-
14
-<img src="https://netdata.cloud/img/microchip.svg" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: sensors
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
-
22
-## Overview
23
-
24
-This collector gathers real-time system sensor statistics, including temperature, voltage, current, power, fan speed, energy consumption, and humidity, utilizing the [sensors](https://linux.die.net/man/1/sensors) binary or [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface).
25
-
26
-
27
-
28
-
29
-This collector is supported on all platforms.
30
-
31
-This collector only supports collecting metrics from a single instance of this integration.
32
-
33
-
34
-### Default Behavior
35
-
36
-#### Auto-Detection
37
-
38
-The following type of sensors are auto-detected:
39
-
40
-- temperature
41
-- fan
42
-- voltage
43
-- current
44
-- power
45
-- energy
46
-- humidity
47
-
48
-
49
-#### Limits
50
-
51
-The default configuration for this integration does not impose any limits on data collection.
52
-
53
-#### Performance Impact
54
-
55
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
56
-
57
-
58
-## Metrics
59
-
60
-Metrics grouped by *scope*.
61
-
62
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
63
-
64
-
65
-
66
-### Per sensor
67
-
68
-These metrics refer to the sensor.
69
-
70
-Labels:
71
-
72
-| Label | Description |
73
-|:-----------|:----------------|
74
-| chip | The hardware component responsible for the sensor monitoring. |
75
-| feature | The specific sensor or monitoring point provided by the chip. |
76
-
77
-Metrics:
78
-
79
-| Metric | Dimensions | Unit |
80
-|:------|:----------|:----|
81
-| sensors.sensor_temperature | temperature | Celsius |
82
-| sensors.sensor_voltage | voltage | Volts |
83
-| sensors.sensor_current | current | Amperes |
84
-| sensors.sensor_power | power | Watts |
85
-| sensors.sensor_fan_speed | fan | RPM |
86
-| sensors.sensor_energy | energy | Joules |
87
-| sensors.sensor_humidity | humidity | percent |
88
-| sensors.sensor_intrusion | alarm_clear, alarm_triggered | status |
89
-
90
-
91
-
92
-## Alerts
93
-
94
-There are no alerts configured by default for this integration.
95
-
96
-
97
-## Setup
98
-
99
-### Prerequisites
100
-
101
-No action required.
102
-
103
-### Configuration
104
-
105
-#### File
106
-
107
-The configuration file name for this integration is `go.d/sensors.conf`.
108
-
109
-
110
-You can edit the configuration file using the `edit-config` script from the
111
-Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
112
-
113
-```bash
114
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
115
-sudo ./edit-config go.d/sensors.conf
116
-```
117
-#### Options
118
-
119
-The following options can be defined globally: update_every.
120
-
121
-
122
-<details open><summary>Config options</summary>
123
-
124
-| Name | Description | Default | Required |
125
-|:----|:-----------|:-------|:--------:|
126
-| update_every | Data collection frequency. | 10 | no |
127
-| binary_path | Path to the `sensors` binary. If left empty or if the binary is not found, [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) will be used to collect sensor statistics. | /usr/bin/sensors | yes |
128
-| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |
129
-
130
-</details>
131
-
132
-#### Examples
133
-
134
-##### Custom binary path
135
-
136
-The executable is not in the directories specified in the PATH environment variable.
137
-
138
-<details open><summary>Config</summary>
139
-
140
-```yaml
141
-jobs:
142
- - name: sensors
143
- binary_path: /usr/local/sbin/sensors
144
-
145
-```
146
-</details>
147
-
148
-##### Use sysfs instead of sensors
149
-
150
-Set `binary_path` to an empty string to use sysfs.
151
-
152
-<details open><summary>Config</summary>
153
-
154
-```yaml
155
-jobs:
156
- - name: sensors
157
- binary_path: ""
158
-
159
-```
160
-</details>
161
-
162
-
163
-
164
-## Troubleshooting
165
-
166
-### Debug Mode
167
-
168
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
169
-
170
-To troubleshoot issues with the `sensors` collector, run the `go.d.plugin` with the debug option enabled. The output
171
-should give you clues as to why the collector isn't working.
172
-
173
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
174
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
175
-
176
- ```bash
177
- cd /usr/libexec/netdata/plugins.d/
178
- ```
179
-
180
-- Switch to the `netdata` user.
181
-
182
- ```bash
183
- sudo -u netdata -s
184
- ```
185
-
186
-- Run the `go.d.plugin` to debug the collector:
187
-
188
- ```bash
189
- ./go.d.plugin -d -m sensors
190
- ```
191
-
192
-### Getting Logs
193
-
194
-If you're encountering problems with the `sensors` collector, follow these steps to retrieve logs and identify potential issues:
195
-
196
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
197
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
198
-
199
-#### System with systemd
200
-
201
-Use the following command to view logs generated since the last Netdata service restart:
202
-
203
-```bash
204
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep sensors
205
-```
206
-
207
-#### System without systemd
208
-
209
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
210
-
211
-```bash
212
-grep sensors /var/log/netdata/collector.log
213
-```
214
-
215
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
216
-
217
-#### Docker Container
218
-
219
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
220
-
221
-```bash
222
-docker logs netdata 2>&1 | grep sensors
223
-```
224
-
225
-