Add hwmon /sensors support (#278)
* Add hwmon support (mainly known from lm-sensors) This commit adds initial support for linux hardware sensors, exported through sysfs. Details of the interface can be found at https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface * Add end-to-end test with some real life data * Cleanup comments on hwmon collector * Drop raw sensor name from hwmon output * Let the sensor label be "sensor" * Add hwmon short description to README.
This commit is contained in:
Rene Treffer
Brian Brazil
parent
cf3710191a
commit
081ecc5db0
99 changed files with 753 additions and 79 deletions
386
collector/hwmon_linux.go
Normal file
386
collector/hwmon_linux.go
Normal file
|
|
@ -0,0 +1,386 @@
|
|||
// Copyright 2016 The Prometheus Authors
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
// +build !nohwmon
|
||||
|
||||
package collector
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
)
|
||||
|
||||
const (
|
||||
hwMonSubsystem = "hwmon"
|
||||
)
|
||||
|
||||
var (
|
||||
hwmonInvalidMetricChars = regexp.MustCompile("[^a-z0-9:_]")
|
||||
hwmonFilenameFormat = regexp.MustCompile(`^(?P<type>[^0-9]+)(?P<id>[0-9]*)?(_(?P<property>.+))?$`)
|
||||
hwmonLabelDesc = []string{"chip", "sensor"}
|
||||
hwmonSensorTypes = []string{
|
||||
"vrm", "beep_enable", "update_interval", "in", "cpu", "fan",
|
||||
"pwm", "temp", "curr", "power", "energy", "humidity",
|
||||
"intrusion",
|
||||
}
|
||||
)
|
||||
|
||||
func init() {
|
||||
Factories["hwmon"] = NewHwMonCollector
|
||||
}
|
||||
|
||||
type hwMonCollector struct{}
|
||||
|
||||
// Takes a prometheus registry and returns a new Collector exposing
|
||||
// /sys/class/hwmon stats (similar to lm-sensors).
|
||||
func NewHwMonCollector() (Collector, error) {
|
||||
return &hwMonCollector{}, nil
|
||||
}
|
||||
|
||||
func cleanMetricName(name string) string {
|
||||
lower := strings.ToLower(name)
|
||||
replaced := hwmonInvalidMetricChars.ReplaceAllLiteralString(lower, "_")
|
||||
cleaned := strings.Trim(replaced, "_")
|
||||
return cleaned
|
||||
}
|
||||
|
||||
func addValueFile(data map[string]map[string]string, sensor string, prop string, file string) {
|
||||
raw, e := ioutil.ReadFile(file)
|
||||
if e != nil {
|
||||
return
|
||||
}
|
||||
value := strings.Trim(string(raw), "\n")
|
||||
|
||||
if _, ok := data[sensor]; !ok {
|
||||
data[sensor] = make(map[string]string)
|
||||
}
|
||||
|
||||
data[sensor][prop] = value
|
||||
}
|
||||
|
||||
// Split a sensor name into <type><num>_<property>
|
||||
func explodeSensorFilename(filename string) (ok bool, sensorType string, sensorNum int, sensorProperty string) {
|
||||
matches := hwmonFilenameFormat.FindStringSubmatch(filename)
|
||||
if len(matches) == 0 {
|
||||
return false, sensorType, sensorNum, sensorProperty
|
||||
}
|
||||
for i, match := range hwmonFilenameFormat.SubexpNames() {
|
||||
if i >= len(matches) {
|
||||
return true, sensorType, sensorNum, sensorProperty
|
||||
}
|
||||
if match == "type" {
|
||||
sensorType = matches[i]
|
||||
}
|
||||
if match == "property" {
|
||||
sensorProperty = matches[i]
|
||||
}
|
||||
if match == "id" && len(matches[i]) > 0 {
|
||||
if num, err := strconv.Atoi(matches[i]); err == nil {
|
||||
sensorNum = num
|
||||
} else {
|
||||
return false, sensorType, sensorNum, sensorProperty
|
||||
}
|
||||
}
|
||||
}
|
||||
return true, sensorType, sensorNum, sensorProperty
|
||||
}
|
||||
|
||||
func collectSensorData(dir string, data map[string]map[string]string) (err error) {
|
||||
sensorFiles, dirError := ioutil.ReadDir(dir)
|
||||
if dirError != nil {
|
||||
return dirError
|
||||
}
|
||||
for _, file := range sensorFiles {
|
||||
filename := file.Name()
|
||||
ok, sensorType, sensorNum, sensorProperty := explodeSensorFilename(filename)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
|
||||
for _, t := range hwmonSensorTypes {
|
||||
if t == sensorType {
|
||||
addValueFile(data, sensorType+strconv.Itoa(sensorNum), sensorProperty, path.Join(dir, file.Name()))
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *hwMonCollector) updateHwmon(ch chan<- prometheus.Metric, dir string) (err error) {
|
||||
hwmonName, err := c.hwmonName(dir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
data := make(map[string]map[string]string)
|
||||
err = collectSensorData(dir, data)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := os.Stat(path.Join(dir, "device")); err == nil {
|
||||
err := collectSensorData(path.Join(dir, "device"), data)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// format all sensors
|
||||
for sensor, sensorData := range data {
|
||||
|
||||
_, sensorType, _, _ := explodeSensorFilename(sensor)
|
||||
|
||||
if labelText, ok := sensorData["label"]; ok {
|
||||
label := cleanMetricName(labelText)
|
||||
if label != "" {
|
||||
sensor = label
|
||||
}
|
||||
}
|
||||
labels := []string{hwmonName, sensor}
|
||||
|
||||
if sensorType == "beep_enable" {
|
||||
value := 0.0
|
||||
if sensorData[""] == "1" {
|
||||
value = 1.0
|
||||
}
|
||||
metricName := "node_hwmon_beep_enabled"
|
||||
desc := prometheus.NewDesc(metricName, "Hardware beep enabled", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, value, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "vrm" {
|
||||
parsedValue, err := strconv.ParseFloat(sensorData[""], 64)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
metricName := "node_hwmon_voltage_regulator_version"
|
||||
desc := prometheus.NewDesc(metricName, "Hardware voltage regulator", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "update_interval" {
|
||||
parsedValue, err := strconv.ParseFloat(sensorData[""], 64)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
metricName := "node_hwmon_update_interval_seconds"
|
||||
desc := prometheus.NewDesc(metricName, "Hardware monitor update interval", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue*0.001, labels...)
|
||||
continue
|
||||
}
|
||||
|
||||
prefix := "node_hwmon_" + sensorType
|
||||
|
||||
for element, value := range sensorData {
|
||||
|
||||
if element == "label" {
|
||||
continue
|
||||
}
|
||||
|
||||
name := prefix
|
||||
if element == "input" {
|
||||
// input is actually the value
|
||||
if _, ok := sensorData[""]; ok {
|
||||
name = name + "_input"
|
||||
}
|
||||
} else if element != "" {
|
||||
name = name + "_" + cleanMetricName(element)
|
||||
}
|
||||
parsedValue, err := strconv.ParseFloat(value, 64)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
|
||||
// special elements, fault, alarm & beep should be handed out without units
|
||||
if element == "fault" || element == "alarm" {
|
||||
desc := prometheus.NewDesc(name, "Hardware sensor "+element+" status ("+sensorType+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(desc, prometheus.GaugeValue, parsedValue, labels...)
|
||||
continue
|
||||
}
|
||||
if element == "beep" {
|
||||
desc := prometheus.NewDesc(name+"_enabled", "Hardware monitor sensor has beeping enabled", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(desc, prometheus.GaugeValue, parsedValue, labels...)
|
||||
continue
|
||||
}
|
||||
|
||||
// everything else should get a unit
|
||||
if sensorType == "in" || sensorType == "cpu" {
|
||||
desc := prometheus.NewDesc(name+"_volts", "Hardware monitor for voltage ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue*0.001, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "temp" && element != "type" {
|
||||
desc := prometheus.NewDesc(name+"_celsius", "Hardware monitor for temperature ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue*0.001, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "curr" {
|
||||
desc := prometheus.NewDesc(name+"_amps", "Hardware monitor for current ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue*0.001, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "energy" {
|
||||
desc := prometheus.NewDesc(name+"_joule_total", "Hardware monitor for joules used so far ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.CounterValue, parsedValue/1000000.0, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "power" && element == "accuracy" {
|
||||
desc := prometheus.NewDesc(name, "Hardware monitor power meter accuracy, as a ratio", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue/1000000.0, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "power" && (element == "average_interval" || element == "average_interval_min" || element == "average_interval_max") {
|
||||
desc := prometheus.NewDesc(name+"_seconds", "Hardware monitor power usage update interval ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue*0.001, labels...)
|
||||
continue
|
||||
}
|
||||
if sensorType == "power" {
|
||||
desc := prometheus.NewDesc(name+"_watt", "Hardware monitor for power usage in watts ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue/1000000.0, labels...)
|
||||
continue
|
||||
}
|
||||
|
||||
if sensorType == "humidity" {
|
||||
desc := prometheus.NewDesc(name, "Hardware monitor for humidity, as a ratio (multiply with 100.0 to get the humidity as a percentage) ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue/1000000.0, labels...)
|
||||
continue
|
||||
}
|
||||
|
||||
if sensorType == "fan" && (element == "input" || element == "min" || element == "max" || element == "target") {
|
||||
desc := prometheus.NewDesc(name+"_rpm", "Hardware monitor for fan revolutions per minute ("+element+")", hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue, labels...)
|
||||
continue
|
||||
}
|
||||
|
||||
// fallback, just dump the metric as is
|
||||
|
||||
desc := prometheus.NewDesc(name, "Hardware monitor "+sensorType+" element "+element, hwmonLabelDesc, nil)
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
desc, prometheus.GaugeValue, parsedValue, labels...)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *hwMonCollector) hwmonName(dir string) (string, error) {
|
||||
// generate a name for a sensor path
|
||||
|
||||
// sensor numbering depends on the order of linux module loading and
|
||||
// is thus unstable.
|
||||
// However the path of the device has to be stable:
|
||||
// - /sys/devices/<bus>/<device>
|
||||
// Some hardware monitors have a "name" file that exports a human
|
||||
// readbale name that can be used.
|
||||
|
||||
// human readable names would be bat0 or coretemp, while a path string
|
||||
// could be platform_applesmc.768
|
||||
|
||||
// preference 1: is there a name file
|
||||
|
||||
sysnameRaw, nameErr := ioutil.ReadFile(path.Join(dir, "name"))
|
||||
if nameErr == nil && string(sysnameRaw) != "" {
|
||||
cleanName := cleanMetricName(string(sysnameRaw))
|
||||
if cleanName != "" {
|
||||
return cleanName, nil
|
||||
}
|
||||
}
|
||||
|
||||
// preference 2: construct a name based on device
|
||||
|
||||
devicePath, devErr := filepath.EvalSymlinks(path.Join(dir, "device"))
|
||||
if devErr == nil {
|
||||
devPathPrefix, devName := path.Split(devicePath)
|
||||
_, devType := path.Split(devPathPrefix)
|
||||
|
||||
cleanDevName := cleanMetricName(devName)
|
||||
cleanDevType := cleanMetricName(devType)
|
||||
|
||||
if cleanDevType != "" && cleanDevName != "" {
|
||||
return cleanDevType + "_" + cleanDevName, nil
|
||||
}
|
||||
|
||||
if cleanDevName != "" {
|
||||
return cleanDevName, nil
|
||||
}
|
||||
}
|
||||
|
||||
// it looks bad, name and device don't provide enough information
|
||||
// return a hwmon[0-9]* name
|
||||
|
||||
realDir, err := filepath.EvalSymlinks(dir)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
// take the last path element, this will be hwmonX
|
||||
_, name := path.Split(realDir)
|
||||
cleanName := cleanMetricName(name)
|
||||
if cleanName != "" {
|
||||
return cleanName, nil
|
||||
}
|
||||
return "", errors.New("Could not derive a monitoring name for " + dir)
|
||||
}
|
||||
|
||||
func (c *hwMonCollector) Update(ch chan<- prometheus.Metric) (err error) {
|
||||
// Step 1: scan /sys/class/hwmon, resolve all symlinks and call
|
||||
// updatesHwmon for each folder
|
||||
|
||||
hwmonPathName := path.Join(sysFilePath("class"), "hwmon")
|
||||
|
||||
hwmonFiles, err := ioutil.ReadDir(hwmonPathName)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, hwDir := range hwmonFiles {
|
||||
hwmonXPathName := path.Join(hwmonPathName, hwDir.Name())
|
||||
|
||||
if hwDir.Mode()&os.ModeSymlink > 0 {
|
||||
hwDir, err = os.Stat(hwmonXPathName)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
if !hwDir.IsDir() {
|
||||
continue
|
||||
}
|
||||
|
||||
if lastErr := c.updateHwmon(ch, hwmonXPathName); lastErr != nil {
|
||||
err = lastErr
|
||||
}
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue