1-Wire Sensors

Plugin: python.d.plugin Module: w1sensor

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 1-Wire Sensors instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
w1sensor.temp	a dimension per sensor	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 python.d/w1sensor.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/w1sensor.conf

Options

There are 2 sections:

• Global variables
• One or more JOBS that can define multiple different instances to monitor.

The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.

Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

Every configuration JOB starts with a job_name value which will appear in the dashboard, unless a name parameter is specified.

Config options

Name	Description	Default	Required
update_every	Sets the default data collection frequency.	5	no
priority	Controls the order of charts at the netdata dashboard.	60000	no
autodetection_retry	Sets the job re-check interval in seconds.	0	no
penalty	Indicates whether to apply penalty to update_every in case of failures.	yes	no
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
name_<1-Wire id>	This allows associating a human readable name with a sensor's 1-Wire identifier.		no

Examples

Provide human readable names

Associate two 1-Wire identifiers with human readable names.

sensors:
 name_00000022276e: 'Machine room'
 name_00000022298f: 'Rack 12'

Troubleshooting

Debug Mode

To troubleshoot issues with the w1sensor collector, run the python.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].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the python.d.plugin to debug the collector:

  ./python.d.plugin w1sensor debug trace