|
@@ -0,0 +1,190 @@
|
|
|
+<!--startmeta
|
|
|
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/w1sensor/README.md"
|
|
|
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/w1sensor/metadata.yaml"
|
|
|
+sidebar_label: "1-Wire Sensors"
|
|
|
+learn_status: "Published"
|
|
|
+learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
|
|
|
+most_popular: False
|
|
|
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
|
|
|
+endmeta-->
|
|
|
+
|
|
|
+# 1-Wire Sensors
|
|
|
+
|
|
|
+
|
|
|
+<img src="https://netdata.cloud/img/1-wire.png" width="150"/>
|
|
|
+
|
|
|
+
|
|
|
+Plugin: go.d.plugin
|
|
|
+Module: w1sensor
|
|
|
+
|
|
|
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
|
|
|
+
|
|
|
+## Overview
|
|
|
+
|
|
|
+Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts.
|
|
|
+
|
|
|
+
|
|
|
+The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected.
|
|
|
+
|
|
|
+This collector is only supported on the following platforms:
|
|
|
+
|
|
|
+- Linux
|
|
|
+
|
|
|
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
|
|
|
+
|
|
|
+
|
|
|
+### Default Behavior
|
|
|
+
|
|
|
+#### Auto-Detection
|
|
|
+
|
|
|
+The collector will try to auto detect available 1-Wire devices.
|
|
|
+
|
|
|
+#### Limits
|
|
|
+
|
|
|
+The default configuration for this integration does not impose any limits on data collection.
|
|
|
+
|
|
|
+#### Performance Impact
|
|
|
+
|
|
|
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
|
|
|
+
|
|
|
+
|
|
|
+## Metrics
|
|
|
+
|
|
|
+Metrics grouped by *scope*.
|
|
|
+
|
|
|
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+### Per sensor
|
|
|
+
|
|
|
+These metrics refer to the 1-Wire Sensor.
|
|
|
+
|
|
|
+This scope has no labels.
|
|
|
+
|
|
|
+Metrics:
|
|
|
+
|
|
|
+| Metric | Dimensions | Unit |
|
|
|
+|:------|:----------|:----|
|
|
|
+| w1sensor.temperature | temperature | Celsius |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## Alerts
|
|
|
+
|
|
|
+There are no alerts configured by default for this integration.
|
|
|
+
|
|
|
+
|
|
|
+## Setup
|
|
|
+
|
|
|
+### Prerequisites
|
|
|
+
|
|
|
+#### Required Linux kernel modules
|
|
|
+
|
|
|
+Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded.
|
|
|
+
|
|
|
+
|
|
|
+### Configuration
|
|
|
+
|
|
|
+#### File
|
|
|
+
|
|
|
+The configuration file name for this integration is `go.d/w1sensor.conf`.
|
|
|
+
|
|
|
+
|
|
|
+You can edit the configuration file using the `edit-config` script from the
|
|
|
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
|
|
|
+
|
|
|
+```bash
|
|
|
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
|
|
|
+sudo ./edit-config go.d/w1sensor.conf
|
|
|
+```
|
|
|
+#### Options
|
|
|
+
|
|
|
+The following options can be defined globally: update_every.
|
|
|
+
|
|
|
+
|
|
|
+<details open><summary>Config options</summary>
|
|
|
+
|
|
|
+| Name | Description | Default | Required |
|
|
|
+|:----|:-----------|:-------|:--------:|
|
|
|
+| update_every | Data collection frequency. | 1 | no |
|
|
|
+| sensors_path | Directory path containing sensor folders with w1_slave files. | /sys/bus/w1/devices | no |
|
|
|
+
|
|
|
+</details>
|
|
|
+
|
|
|
+#### Examples
|
|
|
+
|
|
|
+##### Custom sensor device path
|
|
|
+
|
|
|
+Monitors a virtual sensor when the w1_slave file is located in a custom directory instead of the default location.
|
|
|
+
|
|
|
+```yaml
|
|
|
+jobs:
|
|
|
+ - name: custom_sensors_path
|
|
|
+ sensors_path: /custom/path/devices
|
|
|
+
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
+## Troubleshooting
|
|
|
+
|
|
|
+### Debug Mode
|
|
|
+
|
|
|
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
|
|
|
+
|
|
|
+To troubleshoot issues with the `w1sensor` collector, run the `go.d.plugin` with the debug option enabled. The output
|
|
|
+should give you clues as to why the collector isn't working.
|
|
|
+
|
|
|
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
|
|
|
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
|
|
|
+
|
|
|
+ ```bash
|
|
|
+ cd /usr/libexec/netdata/plugins.d/
|
|
|
+ ```
|
|
|
+
|
|
|
+- Switch to the `netdata` user.
|
|
|
+
|
|
|
+ ```bash
|
|
|
+ sudo -u netdata -s
|
|
|
+ ```
|
|
|
+
|
|
|
+- Run the `go.d.plugin` to debug the collector:
|
|
|
+
|
|
|
+ ```bash
|
|
|
+ ./go.d.plugin -d -m w1sensor
|
|
|
+ ```
|
|
|
+
|
|
|
+### Getting Logs
|
|
|
+
|
|
|
+If you're encountering problems with the `w1sensor` collector, follow these steps to retrieve logs and identify potential issues:
|
|
|
+
|
|
|
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
|
|
|
+- **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.
|
|
|
+
|
|
|
+#### System with systemd
|
|
|
+
|
|
|
+Use the following command to view logs generated since the last Netdata service restart:
|
|
|
+
|
|
|
+```bash
|
|
|
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep w1sensor
|
|
|
+```
|
|
|
+
|
|
|
+#### System without systemd
|
|
|
+
|
|
|
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
|
|
|
+
|
|
|
+```bash
|
|
|
+grep w1sensor /var/log/netdata/collector.log
|
|
|
+```
|
|
|
+
|
|
|
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
|
|
|
+
|
|
|
+#### Docker Container
|
|
|
+
|
|
|
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
|
|
|
+
|
|
|
+```bash
|
|
|
+docker logs netdata 2>&1 | grep w1sensor
|
|
|
+```
|
|
|
+
|
|
|
+
|