netdata/collectors/charts.d.plugin/sensors/sensors.chart.sh

# shellcheck shell=bash
# no need for shebang - this file is loaded from charts.d.plugin
# SPDX-License-Identifier: GPL-3.0-or-later

# netdata
# real-time performance and health monitoring, done right!
# (C) 2016 Costa Tsaousis <costa@tsaousis.gr>
#

# sensors docs
# https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface

# if this chart is called X.chart.sh, then all functions and global variables
# must start with X_

# the directory the kernel keeps sensor data
sensors_sys_dir="${NETDATA_HOST_PREFIX}/sys/devices"

# how deep in the tree to check for sensor data
sensors_sys_depth=10

# if set to 1, the script will overwrite internal
# script functions with code generated ones
# leave to 1, is faster
sensors_source_update=1

# how frequently to collect sensor data
# the default is to collect it at every iteration of charts.d
sensors_update_every=

sensors_priority=90000

declare -A sensors_excluded=()

sensors_find_all_files() {
	find "$1" -maxdepth $sensors_sys_depth -name \*_input -o -name temp 2>/dev/null
}

sensors_find_all_dirs() {
	# shellcheck disable=SC2162
	sensors_find_all_files "$1" | while read; do
		dirname "$REPLY"
	done | sort -u
}

# _check is called once, to find out if this chart should be enabled or not
sensors_check() {

	# this should return:
	#  - 0 to enable the chart
	#  - 1 to disable the chart

	[ -z "$(sensors_find_all_files "$sensors_sys_dir")" ] && error "no sensors found in '$sensors_sys_dir'." && return 1
	return 0
}

sensors_check_files() {
	# we only need sensors that report a non-zero value
	# also remove not needed sensors

	local f v excluded
	for f in "$@"; do
		[ ! -f "$f" ] && continue
		for ex in "${sensors_excluded[@]}"; do
			[[ $f =~ .*$ex$ ]] && excluded='1' && break
		done

		[ "$excluded" != "1" ] && v="$(cat "$f")" || v=0
		v=$((v + 1 - 1))
		[ $v -ne 0 ] && echo "$f" && continue
		excluded=

		error "$f gives zero values"
	done
}

sensors_check_temp_type() {
	# valid temp types are 1 to 6
	# disabled sensors have the value 0

	local f t v
	for f in "$@"; do
		# shellcheck disable=SC2001
		t=$(echo "$f" | sed "s|_input$|_type|g")
		[ "$f" = "$t" ] && echo "$f" && continue
		[ ! -f "$t" ] && echo "$f" && continue

		v="$(cat "$t")"
		v=$((v + 1 - 1))
		[ $v -ne 0 ] && echo "$f" && continue

		error "$f is disabled"
	done
}

# _create is called once, to create the charts
sensors_create() {
	local path dir name x file lfile labelname device subsystem id type mode files multiplier divisor

	# we create a script with the source of the
	# sensors_update() function
	# - the highest speed we can achieve -
	[ $sensors_source_update -eq 1 ] && echo >"$TMP_DIR/sensors.sh" "sensors_update() {"

	for path in $(sensors_find_all_dirs "$sensors_sys_dir" | sort -u); do
		dir=$(basename "$path")
		device=
		subsystem=
		id=
		type=
		name=

		[ -h "$path/device" ] && device=$(readlink -f "$path/device")
		[ ! -z "$device" ] && device=$(basename "$device")
		[ -z "$device" ] && device="$dir"

		[ -h "$path/subsystem" ] && subsystem=$(readlink -f "$path/subsystem")
		[ ! -z "$subsystem" ] && subsystem=$(basename "$subsystem")
		[ -z "$subsystem" ] && subsystem="$dir"

		[ -f "$path/name" ] && name=$(cat "$path/name")
		[ -z "$name" ] && name="$dir"

		[ -f "$path/type" ] && type=$(cat "$path/type")
		[ -z "$type" ] && type="$dir"

		id="$(fixid "$device.$subsystem.$dir")"

		debug "path='$path', dir='$dir', device='$device', subsystem='$subsystem', id='$id', name='$name'"

		for mode in temperature voltage fans power current energy humidity; do
			files=
			multiplier=1
			divisor=1
			algorithm="absolute"

			case $mode in
			temperature)
				files="$(
					ls "$path"/temp*_input 2>/dev/null
					ls "$path/temp" 2>/dev/null
				)"
				files="$(sensors_check_files "$files")"
				files="$(sensors_check_temp_type "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.temp_${id}_${name}' '' 'Temperature' 'Celsius' 'temperature' 'sensors.temp' line $((sensors_priority + 1)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.temp_${id}_${name}' \$1\""
				divisor=1000
				;;

			voltage)
				files="$(ls "$path"/in*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.volt_${id}_${name}' '' 'Voltage' 'Volts' 'voltage' 'sensors.volt' line $((sensors_priority + 2)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.volt_${id}_${name}' \$1\""
				divisor=1000
				;;

			current)
				files="$(ls "$path"/curr*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.curr_${id}_${name}' '' 'Current' 'Ampere' 'current' 'sensors.curr' line $((sensors_priority + 3)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.curr_${id}_${name}' \$1\""
				divisor=1000
				;;

			power)
				files="$(ls "$path"/power*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.power_${id}_${name}' '' 'Power' 'Watt' 'power' 'sensors.power' line $((sensors_priority + 4)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.power_${id}_${name}' \$1\""
				divisor=1000000
				;;

			fans)
				files="$(ls "$path"/fan*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.fan_${id}_${name}' '' 'Fans Speed' 'Rotations / Minute' 'fans' 'sensors.fans' line $((sensors_priority + 5)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.fan_${id}_${name}' \$1\""
				;;

			energy)
				files="$(ls "$path"/energy*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.energy_${id}_${name}' '' 'Energy' 'Joule' 'energy' 'sensors.energy' areastack $((sensors_priority + 6)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.energy_${id}_${name}' \$1\""
				algorithm="incremental"
				divisor=1000000
				;;

			humidity)
				files="$(ls "$path"/humidity*_input 2>/dev/null)"
				files="$(sensors_check_files "$files")"
				[ -z "$files" ] && continue
				echo "CHART 'sensors.humidity_${id}_${name}' '' 'Humidity' 'Percent' 'humidity' 'sensors.humidity' line $((sensors_priority + 7)) $sensors_update_every '' '' 'sensors'"
				echo >>"$TMP_DIR/sensors.sh" "echo \"BEGIN 'sensors.humidity_${id}_${name}' \$1\""
				divisor=1000
				;;

			*)
				continue
				;;
			esac

			for x in $files; do
				file="$x"
				fid="$(fixid "$file")"
				lfile="$(basename "$file" | sed "s|_input$|_label|g")"
				labelname="$(basename "$file" | sed "s|_input$||g")"

				if [ ! "$path/$lfile" = "$file" ] && [ -f "$path/$lfile" ]; then
					labelname="$(cat "$path/$lfile")"
				fi

				echo "DIMENSION $fid '$labelname' $algorithm $multiplier $divisor"
				echo >>"$TMP_DIR/sensors.sh" "echo \"SET $fid = \"\$(< $file )"
			done

			echo >>"$TMP_DIR/sensors.sh" "echo END"
		done
	done

	[ $sensors_source_update -eq 1 ] && echo >>"$TMP_DIR/sensors.sh" "}"

	# ok, load the function sensors_update() we created
	# shellcheck source=/dev/null
	[ $sensors_source_update -eq 1 ] && . "$TMP_DIR/sensors.sh"

	return 0
}

# _update is called continuously, to collect the values
sensors_update() {
	# the first argument to this function is the microseconds since last update
	# pass this parameter to the BEGIN statement (see below).

	# do all the work to collect / calculate the values
	# for each dimension
	# remember: KEEP IT SIMPLE AND SHORT

	# shellcheck source=/dev/null
	[ $sensors_source_update -eq 0 ] && . "$TMP_DIR/sensors.sh" "$1"

	return 0
}