Merge 902650fd37 into d6d0e710bb

collector/powersupplyclass.go

@@ -25,11 +25,13 @@ import (
 
 var (
 	powerSupplyClassIgnoredPowerSupplies = kingpin.Flag("collector.powersupply.ignored-supplies", "Regexp of power supplies to ignore for powersupplyclass collector.").Default("^$").String()
+	powerSupplyClassUseNewNames          = kingpin.Flag("collector.powersupply.use-new-names", "Use new metric names for powersupplyclass collector.").Bool()
 )
 
 type powerSupplyClassCollector struct {
 	subsystem      string
 	ignoredPattern *regexp.Regexp
+	useNewNames    bool
 	metricDescs    map[string]*prometheus.Desc
 	logger         *slog.Logger
 }
@@ -43,6 +45,7 @@ func NewPowerSupplyClassCollector(logger *slog.Logger) (Collector, error) {
 	return &powerSupplyClassCollector{
 		subsystem:      "power_supply",
 		ignoredPattern: pattern,
+		useNewNames:    *powerSupplyClassUseNewNames,
 		metricDescs:    map[string]*prometheus.Desc{},
 		logger:         logger,
 	}, nil

collector/powersupplyclass_darwin.go

@@ -183,6 +183,7 @@ import "C"
 import (
 	"fmt"
 	"strconv"
+	"strings"
 
 	"github.com/prometheus/client_golang/prometheus"
 )
@@ -214,6 +215,48 @@ func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
 				),
 				prometheus.GaugeValue, *value, powerSupplyName,
 			)
+
+			if c.useNewNames {
+				newValue := *value
+				newName := name
+				switch {
+				case name == "voltage_volt":
+					newName = "voltage_volts"
+				case name == "current_ampere":
+					newName = "current_amperes"
+				case strings.HasSuffix(name, "_capacity"):
+					newName = strings.TrimSuffix(name, "_capacity") + "_capacity_coulombs"
+					newValue *= 3.6 // 1 mAh = 3.6 Coulombs
+				case name == "charging":
+				}
+
+				if newName != name {
+					ch <- prometheus.MustNewConstMetric(
+						prometheus.NewDesc(
+							prometheus.BuildFQName(namespace, c.subsystem, newName),
+							fmt.Sprintf("IOKit Power Source information field %s for <power_supply>.", newName),
+							[]string{"power_supply"}, nil,
+						),
+						prometheus.GaugeValue, newValue, powerSupplyName,
+					)
+				}
+			}
+		}
+
+		if c.useNewNames {
+			// Add capacity_ratio for consistency with Linux
+			data := getPowerSourceDescriptorMap(info)
+			if data["current_capacity"] != nil && data["max_capacity"] != nil && *data["max_capacity"] > 0 {
+				ratio := *data["current_capacity"] / *data["max_capacity"]
+				ch <- prometheus.MustNewConstMetric(
+					prometheus.NewDesc(
+						prometheus.BuildFQName(namespace, c.subsystem, "capacity_ratio"),
+						"IOKit Power Source capacity ratio for <power_supply>.",
+						[]string{"power_supply"}, nil,
+					),
+					prometheus.GaugeValue, ratio, powerSupplyName,
+				)
+			}
 		}
 
 		pushEnumMetric(

collector/powersupplyclass_linux.go

@@ -50,6 +50,24 @@ func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
 		} {
 			if value != nil {
 				pushPowerSupplyMetric(ch, c.subsystem, name, float64(*value), powerSupply.Name, prometheus.GaugeValue)
+				if c.useNewNames {
+					newValue := float64(*value)
+					newName := name
+					switch name {
+					case "capacity":
+						newName = "capacity_ratio"
+						newValue /= 100
+					case "capacity_alert_max":
+						newName = "capacity_alert_max_ratio"
+						newValue /= 100
+					case "capacity_alert_min":
+						newName = "capacity_alert_min_ratio"
+						newValue /= 100
+					}
+					if newName != name {
+						pushPowerSupplyMetric(ch, c.subsystem, newName, newValue, powerSupply.Name, prometheus.GaugeValue)
+					}
+				}
 			}
 		}
 
@@ -88,6 +106,37 @@ func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
 		} {
 			if value != nil {
 				pushPowerSupplyMetric(ch, c.subsystem, name, float64(*value)/1e6, powerSupply.Name, prometheus.GaugeValue)
+				if c.useNewNames {
+					newValue := float64(*value) / 1e6
+					newName := name
+					switch {
+					case strings.Contains(name, "current"):
+						if !strings.HasSuffix(name, "_amperes") {
+							newName = strings.TrimSuffix(name, "_ampere") + "_amperes"
+						}
+					case strings.Contains(name, "voltage"):
+						if !strings.HasSuffix(name, "_volts") {
+							newName = strings.TrimSuffix(name, "_volt") + "_volts"
+						}
+					case strings.Contains(name, "energy"):
+						if !strings.HasSuffix(name, "_joules") {
+							newName = strings.TrimSuffix(name, "_watthour") + "_joules"
+							newValue *= 3600
+						}
+					case strings.Contains(name, "charge"):
+						if !strings.HasSuffix(name, "_coulombs") {
+							newName = strings.TrimSuffix(name, "_ampere") + "_coulombs"
+							newValue *= 3600
+						}
+					case strings.Contains(name, "power"):
+						if !strings.HasSuffix(name, "_watts") {
+							newName = strings.TrimSuffix(name, "_watt") + "_watts"
+						}
+					}
+					if newName != name {
+						pushPowerSupplyMetric(ch, c.subsystem, newName, newValue, powerSupply.Name, prometheus.GaugeValue)
+					}
+				}
 			}
 		}
 
@@ -132,7 +181,7 @@ func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
 
 		fieldDesc := prometheus.NewDesc(
 			prometheus.BuildFQName(namespace, c.subsystem, "info"),
-			"info of /sys/class/power_supply/<power_supply>.",
+			"Power supply information from /sys/class/power_supply.",
 			keys,
 			nil,
 		)
@@ -146,7 +195,7 @@ func (c *powerSupplyClassCollector) Update(ch chan<- prometheus.Metric) error {
 func pushPowerSupplyMetric(ch chan<- prometheus.Metric, subsystem string, name string, value float64, powerSupplyName string, valueType prometheus.ValueType) {
 	fieldDesc := prometheus.NewDesc(
 		prometheus.BuildFQName(namespace, subsystem, name),
-		fmt.Sprintf("%s value of /sys/class/power_supply/<power_supply>.", name),
+		fmt.Sprintf("The %s value of /sys/class/power_supply/<power_supply>.", name),
 		[]string{"power_supply"},
 		nil,
 	)