Regenerate integrations.js (#18473)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Sep 4, 2024 at 05:49 UTC
d8c5109a00c707465024992133ddbe0a998f10ec
5 files changed
+266
-75
integrations/integrations.js
+37
-37
@@ -17125,6 +17125,43 @@ export const integrations = [
17125
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/vsphere/metadata.yaml",
17126
"related_resources": ""
17127
},
17128
+ {
17129
+ "meta": {
17130
+ "plugin_name": "go.d.plugin",
17131
+ "module_name": "w1sensor",
17132
+ "monitored_instance": {
17133
+ "name": "1-Wire Sensors",
17134
+ "link": "https://www.analog.com/en/product-category/1wire-temperature-sensors.html",
17135
+ "categories": [
17136
+ "data-collection.hardware-devices-and-sensors"
17137
+ ],
17138
+ "icon_filename": "1-wire.png"
17139
+ },
17140
+ "related_resources": {
17141
+ "integrations": {
17142
+ "list": []
17143
+ }
17144
+ },
17145
+ "info_provided_to_referring_integrations": {
17146
+ "description": ""
17147
+ },
17148
+ "keywords": [
17149
+ "temperature",
17150
+ "sensor",
17151
+ "1-wire"
17152
+ ],
17153
+ "most_popular": false
17154
+ },
17155
+ "overview": "# 1-Wire Sensors\n\nPlugin: go.d.plugin\nModule: w1sensor\n\n## Overview\n\nMonitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.\n\n\nThe collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.\n\nThis collector is only supported on the following platforms:\n\n- Linux\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector will try to auto detect available 1-Wire devices.\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",
17156
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Required Linux kernel modules\n\nMake sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/w1sensor.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/w1sensor.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. | 1 | no |\n| sensors_path | Directory path containing sensor folders with w1_slave files. | /sys/bus/w1/devices | no |\n\n{% /details %}\n#### Examples\n\n##### Custom sensor device path\n\nMonitors a virtual sensor when the w1_slave file is located in a custom directory instead of the default location.\n\n```yaml\njobs:\n - name: custom_sensors_path\n sensors_path: /custom/path/devices\n\n```\n",
17157
+ "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 `w1sensor` 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 w1sensor\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `w1sensor` 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 w1sensor\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 w1sensor /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 w1sensor\n```\n\n",
17158
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
17159
+ "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 1-Wire Sensor.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| w1sensor.temperature | temperature | Celsius |\n\n",
17160
+ "integration_type": "collector",
17161
+ "id": "go.d.plugin-w1sensor-1-Wire_Sensors",
17162
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/w1sensor/metadata.yaml",
17163
+ "related_resources": ""
17164
+ },
17165
{
17166
"meta": {
17167
"id": "collector-go.d.plugin-web_log",
@@ -19299,43 +19336,6 @@ export const integrations = [
19336
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/varnish/metadata.yaml",
19337
"related_resources": ""
19338
},
19302
- {
19303
- "meta": {
19304
- "plugin_name": "python.d.plugin",
19305
- "module_name": "w1sensor",
19306
- "monitored_instance": {
19307
- "name": "1-Wire Sensors",
19308
- "link": "https://www.analog.com/en/product-category/1wire-temperature-sensors.html",
19309
- "categories": [
19310
- "data-collection.hardware-devices-and-sensors"
19311
- ],
19312
- "icon_filename": "1-wire.png"
19313
- },
19314
- "related_resources": {
19315
- "integrations": {
19316
- "list": []
19317
- }
19318
- },
19319
- "info_provided_to_referring_integrations": {
19320
- "description": ""
19321
- },
19322
- "keywords": [
19323
- "temperature",
19324
- "sensor",
19325
- "1-wire"
19326
- ],
19327
- "most_popular": false
19328
- },
19329
- "overview": "# 1-Wire Sensors\n\nPlugin: python.d.plugin\nModule: w1sensor\n\n## Overview\n\nMonitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.\n\nThe collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.\n\nThis collector is only supported on the following platforms:\n\n- Linux\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector will try to auto detect available 1-Wire devices.\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",
19330
- "setup": "## Setup\n\n### Prerequisites\n\n#### Required Linux kernel modules\n\nMake sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/w1sensor.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 python.d/w1sensor.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 open=true 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| name_<1-Wire id> | This allows associating a human readable name with a sensor's 1-Wire identifier. | | no |\n\n{% /details %}\n#### Examples\n\n##### Provide human readable names\n\nAssociate two 1-Wire identifiers with human readable names.\n\n```yaml\nsensors:\n name_00000022276e: 'Machine room'\n name_00000022298f: 'Rack 12'\n\n```\n",
19331
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n\nTo troubleshoot issues with the `w1sensor` 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 w1sensor debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `w1sensor` 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 w1sensor\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 w1sensor /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 w1sensor\n```\n\n",
19332
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19333
- "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 1-Wire Sensors 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| w1sensor.temp | a dimension per sensor | Celsius |\n\n",
19334
- "integration_type": "collector",
19335
- "id": "python.d.plugin-w1sensor-1-Wire_Sensors",
19336
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/w1sensor/metadata.yaml",
19337
- "related_resources": ""
19338
- },
19339
{
19340
"meta": {
19341
"plugin_name": "python.d.plugin",
integrations/integrations.json
+37
-37
@@ -17123,6 +17123,43 @@
17123
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/vsphere/metadata.yaml",
17124
"related_resources": ""
17125
},
17126
+ {
17127
+ "meta": {
17128
+ "plugin_name": "go.d.plugin",
17129
+ "module_name": "w1sensor",
17130
+ "monitored_instance": {
17131
+ "name": "1-Wire Sensors",
17132
+ "link": "https://www.analog.com/en/product-category/1wire-temperature-sensors.html",
17133
+ "categories": [
17134
+ "data-collection.hardware-devices-and-sensors"
17135
+ ],
17136
+ "icon_filename": "1-wire.png"
17137
+ },
17138
+ "related_resources": {
17139
+ "integrations": {
17140
+ "list": []
17141
+ }
17142
+ },
17143
+ "info_provided_to_referring_integrations": {
17144
+ "description": ""
17145
+ },
17146
+ "keywords": [
17147
+ "temperature",
17148
+ "sensor",
17149
+ "1-wire"
17150
+ ],
17151
+ "most_popular": false
17152
+ },
17153
+ "overview": "# 1-Wire Sensors\n\nPlugin: go.d.plugin\nModule: w1sensor\n\n## Overview\n\nMonitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.\n\n\nThe collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.\n\nThis collector is only supported on the following platforms:\n\n- Linux\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector will try to auto detect available 1-Wire devices.\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",
17154
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Required Linux kernel modules\n\nMake sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/w1sensor.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/w1sensor.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. | 1 | no |\n| sensors_path | Directory path containing sensor folders with w1_slave files. | /sys/bus/w1/devices | no |\n\n#### Examples\n\n##### Custom sensor device path\n\nMonitors a virtual sensor when the w1_slave file is located in a custom directory instead of the default location.\n\n```yaml\njobs:\n - name: custom_sensors_path\n sensors_path: /custom/path/devices\n\n```\n",
17155
+ "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 `w1sensor` 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 w1sensor\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `w1sensor` 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 w1sensor\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 w1sensor /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 w1sensor\n```\n\n",
17156
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
17157
+ "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 1-Wire Sensor.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| w1sensor.temperature | temperature | Celsius |\n\n",
17158
+ "integration_type": "collector",
17159
+ "id": "go.d.plugin-w1sensor-1-Wire_Sensors",
17160
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/w1sensor/metadata.yaml",
17161
+ "related_resources": ""
17162
+ },
17163
{
17164
"meta": {
17165
"id": "collector-go.d.plugin-web_log",
@@ -19297,43 +19334,6 @@
19334
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/varnish/metadata.yaml",
19335
"related_resources": ""
19336
},
19300
- {
19301
- "meta": {
19302
- "plugin_name": "python.d.plugin",
19303
- "module_name": "w1sensor",
19304
- "monitored_instance": {
19305
- "name": "1-Wire Sensors",
19306
- "link": "https://www.analog.com/en/product-category/1wire-temperature-sensors.html",
19307
- "categories": [
19308
- "data-collection.hardware-devices-and-sensors"
19309
- ],
19310
- "icon_filename": "1-wire.png"
19311
- },
19312
- "related_resources": {
19313
- "integrations": {
19314
- "list": []
19315
- }
19316
- },
19317
- "info_provided_to_referring_integrations": {
19318
- "description": ""
19319
- },
19320
- "keywords": [
19321
- "temperature",
19322
- "sensor",
19323
- "1-wire"
19324
- ],
19325
- "most_popular": false
19326
- },
19327
- "overview": "# 1-Wire Sensors\n\nPlugin: python.d.plugin\nModule: w1sensor\n\n## Overview\n\nMonitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.\n\nThe collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.\n\nThis collector is only supported on the following platforms:\n\n- Linux\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector will try to auto detect available 1-Wire devices.\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",
19328
- "setup": "## Setup\n\n### Prerequisites\n\n#### Required Linux kernel modules\n\nMake sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/w1sensor.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 python.d/w1sensor.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| name_<1-Wire id> | This allows associating a human readable name with a sensor's 1-Wire identifier. | | no |\n\n#### Examples\n\n##### Provide human readable names\n\nAssociate two 1-Wire identifiers with human readable names.\n\n```yaml\nsensors:\n name_00000022276e: 'Machine room'\n name_00000022298f: 'Rack 12'\n\n```\n",
19329
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n\nTo troubleshoot issues with the `w1sensor` 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 w1sensor debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `w1sensor` 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 w1sensor\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 w1sensor /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 w1sensor\n```\n\n",
19330
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19331
- "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 1-Wire Sensors 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| w1sensor.temp | a dimension per sensor | Celsius |\n\n",
19332
- "integration_type": "collector",
19333
- "id": "python.d.plugin-w1sensor-1-Wire_Sensors",
19334
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/w1sensor/metadata.yaml",
19335
- "related_resources": ""
19336
- },
19337
{
19338
"meta": {
19339
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -459,7 +459,7 @@ If you don't see the app/service you'd like to monitor in this list:
459
460
### Hardware Devices and Sensors
461
462
-- [1-Wire Sensors](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/w1sensor/integrations/1-wire_sensors.md)
462
+- [1-Wire Sensors](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/w1sensor/integrations/1-wire_sensors.md)
463
464
- [AM2320](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/am2320/integrations/am2320.md)
465
src/go/plugin/go.d/modules/w1sensor/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/1-wire_sensors.md
\ No newline at end of file
src/go/plugin/go.d/modules/w1sensor/integrations/1-wire_sensors.md
new
+190
@@ -0,0 +1,190 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/w1sensor/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/w1sensor/metadata.yaml"
4
+sidebar_label: "1-Wire 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
+# 1-Wire Sensors
12
+
13
+
14
+<img src="https://netdata.cloud/img/1-wire.png" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: w1sensor
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.
25
+
26
+
27
+The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.
28
+
29
+This collector is only supported on the following platforms:
30
+
31
+- Linux
32
+
33
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
+
35
+
36
+### Default Behavior
37
+
38
+#### Auto-Detection
39
+
40
+The collector will try to auto detect available 1-Wire devices.
41
+
42
+#### Limits
43
+
44
+The default configuration for this integration does not impose any limits on data collection.
45
+
46
+#### Performance Impact
47
+
48
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
+
50
+
51
+## Metrics
52
+
53
+Metrics grouped by *scope*.
54
+
55
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
56
+
57
+
58
+
59
+### Per sensor
60
+
61
+These metrics refer to the 1-Wire Sensor.
62
+
63
+This scope has no labels.
64
+
65
+Metrics:
66
+
67
+| Metric | Dimensions | Unit |
68
+|:------|:----------|:----|
69
+| w1sensor.temperature | temperature | Celsius |
70
+
71
+
72
+
73
+## Alerts
74
+
75
+There are no alerts configured by default for this integration.
76
+
77
+
78
+## Setup
79
+
80
+### Prerequisites
81
+
82
+#### Required Linux kernel modules
83
+
84
+Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.
85
+
86
+
87
+### Configuration
88
+
89
+#### File
90
+
91
+The configuration file name for this integration is `go.d/w1sensor.conf`.
92
+
93
+
94
+You can edit the configuration file using the `edit-config` script from the
95
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
96
+
97
+```bash
98
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
99
+sudo ./edit-config go.d/w1sensor.conf
100
+```
101
+#### Options
102
+
103
+The following options can be defined globally: update_every.
104
+
105
+
106
+<details open><summary>Config options</summary>
107
+
108
+| Name | Description | Default | Required |
109
+|:----|:-----------|:-------|:--------:|
110
+| update_every | Data collection frequency. | 1 | no |
111
+| sensors_path | Directory path containing sensor folders with w1_slave files. | /sys/bus/w1/devices | no |
112
+
113
+</details>
114
+
115
+#### Examples
116
+
117
+##### Custom sensor device path
118
+
119
+Monitors a virtual sensor when the w1_slave file is located in a custom directory instead of the default location.
120
+
121
+```yaml
122
+jobs:
123
+ - name: custom_sensors_path
124
+ sensors_path: /custom/path/devices
125
+
126
+```
127
+
128
+
129
+## Troubleshooting
130
+
131
+### Debug Mode
132
+
133
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
134
+
135
+To troubleshoot issues with the `w1sensor` collector, run the `go.d.plugin` with the debug option enabled. The output
136
+should give you clues as to why the collector isn't working.
137
+
138
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
139
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
140
+
141
+ ```bash
142
+ cd /usr/libexec/netdata/plugins.d/
143
+ ```
144
+
145
+- Switch to the `netdata` user.
146
+
147
+ ```bash
148
+ sudo -u netdata -s
149
+ ```
150
+
151
+- Run the `go.d.plugin` to debug the collector:
152
+
153
+ ```bash
154
+ ./go.d.plugin -d -m w1sensor
155
+ ```
156
+
157
+### Getting Logs
158
+
159
+If you're encountering problems with the `w1sensor` collector, follow these steps to retrieve logs and identify potential issues:
160
+
161
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
162
+- **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.
163
+
164
+#### System with systemd
165
+
166
+Use the following command to view logs generated since the last Netdata service restart:
167
+
168
+```bash
169
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep w1sensor
170
+```
171
+
172
+#### System without systemd
173
+
174
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
175
+
176
+```bash
177
+grep w1sensor /var/log/netdata/collector.log
178
+```
179
+
180
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
181
+
182
+#### Docker Container
183
+
184
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
185
+
186
+```bash
187
+docker logs netdata 2>&1 | grep w1sensor
188
+```
189
+
190
+