Regenerate integrations.js (#17472)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 22, 2024 at 11:57 UTC
19c7bcb5a458c71040ad5fe4f34180ba3da631de
5 files changed
+269
integrations/integrations.js
+43
@@ -15752,6 +15752,49 @@ export const integrations = [
15752
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/scaleio/metadata.yaml",
15753
"related_resources": ""
15754
},
15755
+ {
15756
+ "meta": {
15757
+ "id": "collector-go.d.plugin-sensors",
15758
+ "plugin_name": "go.d.plugin",
15759
+ "module_name": "sensors",
15760
+ "monitored_instance": {
15761
+ "name": "Linux Sensors (lm-sensors)",
15762
+ "link": "https://hwmon.wiki.kernel.org/lm_sensors",
15763
+ "icon_filename": "microchip.svg",
15764
+ "categories": [
15765
+ "data-collection.hardware-devices-and-sensors"
15766
+ ]
15767
+ },
15768
+ "keywords": [
15769
+ "sensors",
15770
+ "temperature",
15771
+ "voltage",
15772
+ "current",
15773
+ "power",
15774
+ "fan",
15775
+ "energy",
15776
+ "humidity"
15777
+ ],
15778
+ "related_resources": {
15779
+ "integrations": {
15780
+ "list": []
15781
+ }
15782
+ },
15783
+ "info_provided_to_referring_integrations": {
15784
+ "description": ""
15785
+ },
15786
+ "most_popular": false
15787
+ },
15788
+ "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.\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",
15789
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Install lm-sensors\n\n- Install `lm-sensors` using your distribution's package manager.\n- Run `sensors-detect` to detect hardware monitoring chips.\n\n\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](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/sensors.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| binary_path | Path to the `sensors` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /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 summary=\"Config\" %}\n```yaml\njobs:\n - name: sensors\n binary_path: /usr/local/sbin/sensors\n\n```\n{% /details %}\n",
15790
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\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",
15791
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15792
+ "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\n",
15793
+ "integration_type": "collector",
15794
+ "id": "go.d.plugin-sensors-Linux_Sensors_(lm-sensors)",
15795
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/sensors/metadata.yaml",
15796
+ "related_resources": ""
15797
+ },
15798
{
15799
"meta": {
15800
"id": "collector-go.d.plugin-snmp",
integrations/integrations.json
+43
@@ -15750,6 +15750,49 @@
15750
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/scaleio/metadata.yaml",
15751
"related_resources": ""
15752
},
15753
+ {
15754
+ "meta": {
15755
+ "id": "collector-go.d.plugin-sensors",
15756
+ "plugin_name": "go.d.plugin",
15757
+ "module_name": "sensors",
15758
+ "monitored_instance": {
15759
+ "name": "Linux Sensors (lm-sensors)",
15760
+ "link": "https://hwmon.wiki.kernel.org/lm_sensors",
15761
+ "icon_filename": "microchip.svg",
15762
+ "categories": [
15763
+ "data-collection.hardware-devices-and-sensors"
15764
+ ]
15765
+ },
15766
+ "keywords": [
15767
+ "sensors",
15768
+ "temperature",
15769
+ "voltage",
15770
+ "current",
15771
+ "power",
15772
+ "fan",
15773
+ "energy",
15774
+ "humidity"
15775
+ ],
15776
+ "related_resources": {
15777
+ "integrations": {
15778
+ "list": []
15779
+ }
15780
+ },
15781
+ "info_provided_to_referring_integrations": {
15782
+ "description": ""
15783
+ },
15784
+ "most_popular": false
15785
+ },
15786
+ "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.\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",
15787
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Install lm-sensors\n\n- Install `lm-sensors` using your distribution's package manager.\n- Run `sensors-detect` to detect hardware monitoring chips.\n\n\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](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/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 an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /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",
15788
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\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",
15789
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15790
+ "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\n",
15791
+ "integration_type": "collector",
15792
+ "id": "go.d.plugin-sensors-Linux_Sensors_(lm-sensors)",
15793
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/sensors/metadata.yaml",
15794
+ "related_resources": ""
15795
+ },
15796
{
15797
"meta": {
15798
"id": "collector-go.d.plugin-snmp",
src/collectors/COLLECTORS.md
+2
@@ -507,6 +507,8 @@ If you don't see the app/service you'd like to monitor in this list:
507
508
- [Linux Sensors (lm-sensors)](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/sensors/integrations/linux_sensors_lm-sensors.md)
509
510
+- [Linux Sensors (lm-sensors)](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/sensors/integrations/linux_sensors_lm-sensors.md)
511
+
512
- [Linux Sensors (sysfs)](https://github.com/netdata/netdata/blob/master/src/collectors/charts.d.plugin/sensors/integrations/linux_sensors_sysfs.md)
513
514
- [NVML](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/nvml.md)
src/go/collectors/go.d.plugin/modules/sensors/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/linux_sensors_lm-sensors.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/sensors/integrations/linux_sensors_lm-sensors.md
new
+180
@@ -0,0 +1,180 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/sensors/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/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.
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
+
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
+#### Install lm-sensors
101
+
102
+- Install `lm-sensors` using your distribution's package manager.
103
+- Run `sensors-detect` to detect hardware monitoring chips.
104
+
105
+
106
+
107
+### Configuration
108
+
109
+#### File
110
+
111
+The configuration file name for this integration is `go.d/sensors.conf`.
112
+
113
+
114
+You can edit the configuration file using the `edit-config` script from the
115
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
116
+
117
+```bash
118
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
119
+sudo ./edit-config go.d/sensors.conf
120
+```
121
+#### Options
122
+
123
+The following options can be defined globally: update_every.
124
+
125
+
126
+<details><summary>Config options</summary>
127
+
128
+| Name | Description | Default | Required |
129
+|:----|:-----------|:-------|:--------:|
130
+| update_every | Data collection frequency. | 10 | no |
131
+| binary_path | Path to the `sensors` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/bin/sensors | yes |
132
+| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |
133
+
134
+</details>
135
+
136
+#### Examples
137
+
138
+##### Custom binary path
139
+
140
+The executable is not in the directories specified in the PATH environment variable.
141
+
142
+<details><summary>Config</summary>
143
+
144
+```yaml
145
+jobs:
146
+ - name: sensors
147
+ binary_path: /usr/local/sbin/sensors
148
+
149
+```
150
+</details>
151
+
152
+
153
+
154
+## Troubleshooting
155
+
156
+### Debug Mode
157
+
158
+To troubleshoot issues with the `sensors` collector, run the `go.d.plugin` with the debug option enabled. The output
159
+should give you clues as to why the collector isn't working.
160
+
161
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
162
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
163
+
164
+ ```bash
165
+ cd /usr/libexec/netdata/plugins.d/
166
+ ```
167
+
168
+- Switch to the `netdata` user.
169
+
170
+ ```bash
171
+ sudo -u netdata -s
172
+ ```
173
+
174
+- Run the `go.d.plugin` to debug the collector:
175
+
176
+ ```bash
177
+ ./go.d.plugin -d -m sensors
178
+ ```
179
+
180
+