diskstats_linux.go: add collector.diskstats.disable-queue-stats flag

Skips call to `SysBlockDeviceQueueStats` to improve performance over a large number of devices.
This commit is contained in:
Will Jordan 2025-03-26 13:38:29 -07:00
parent 47e2bb34ce
commit 66ed666f2e

View file

@ -24,6 +24,7 @@ import (
"strconv"
"strings"
"github.com/alecthomas/kingpin/v2"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/procfs/blockdevice"
)
@ -65,6 +66,10 @@ const (
udevSCSIIdentSerial = "SCSI_IDENT_SERIAL"
)
var (
disableQueueStats = kingpin.Flag("collector.diskstats.disable-queue-stats", "disable queue stats").Default("false").Bool()
)
type typedFactorDesc struct {
desc *prometheus.Desc
valueType prometheus.ValueType
@ -106,13 +111,16 @@ func NewDiskstatsCollector(logger *slog.Logger) (Collector, error) {
return nil, fmt.Errorf("failed to parse device filter flags: %w", err)
}
infoLabels := []string{"device", "major", "minor", "path", "wwn", "model", "serial", "revision"}
if !*disableQueueStats {
infoLabels = append(infoLabels, "rotational")
}
collector := diskstatsCollector{
deviceFilter: deviceFilter,
fs: fs,
infoDesc: typedFactorDesc{
desc: prometheus.NewDesc(prometheus.BuildFQName(namespace, diskSubsystem, "info"),
"Info of /sys/block/<block_device>.",
[]string{"device", "major", "minor", "path", "wwn", "model", "serial", "revision", "rotational"},
"Info of /sys/block/<block_device>.", infoLabels,
nil,
), valueType: prometheus.GaugeValue,
},
@ -294,13 +302,8 @@ func (c *diskstatsCollector) Update(ch chan<- prometheus.Metric) error {
serial = info[udevIDSerialShort]
}
queueStats, err := c.fs.SysBlockDeviceQueueStats(dev)
// Block Device Queue stats may not exist for all devices.
if err != nil && !os.IsNotExist(err) {
c.logger.Debug("Failed to get block device queue stats", "device", dev, "err", err)
}
ch <- c.infoDesc.mustNewConstMetric(1.0, dev,
labels := []string{
dev,
fmt.Sprint(stats.MajorNumber),
fmt.Sprint(stats.MinorNumber),
info[udevIDPath],
@ -308,8 +311,18 @@ func (c *diskstatsCollector) Update(ch chan<- prometheus.Metric) error {
info[udevIDModel],
serial,
info[udevIDRevision],
strconv.FormatUint(queueStats.Rotational, 2),
)
}
if !*disableQueueStats {
queueStats, err := c.fs.SysBlockDeviceQueueStats(dev)
// Block Device Queue stats may not exist for all devices.
if err != nil && !os.IsNotExist(err) {
c.logger.Debug("Failed to get block device queue stats", "device", dev, "err", err)
}
labels = append(labels, strconv.FormatUint(queueStats.Rotational, 2))
}
ch <- c.infoDesc.mustNewConstMetric(1.0, labels...)
statCount := stats.IoStatsCount - 3 // Total diskstats record count, less MajorNumber, MinorNumber and DeviceName