Adding allowed_device flag for diskstats Collector

.github/workflows/golangci-lint.yml

@@ -21,6 +21,9 @@ jobs:
         uses: actions/setup-go@v2
         with:
           go-version: 1.18.x
+      - name: Install snmp_exporter/generator dependencies
+        run: sudo apt-get update && sudo apt-get -y install libsnmp-dev
+        if: github.repository == 'prometheus/snmp_exporter'
       - name: Lint
         uses: golangci/golangci-lint-action@v3.1.0
         with:

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
-## Prometheus Community Code of Conduct
+# Prometheus Community Code of Conduct
 
-Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
+Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).

SECURITY.md

@@ -3,4 +3,4 @@
 The Prometheus security policy, including how to report vulnerabilities, can be
 found here:
 
-https://prometheus.io/docs/operating/security/
+<https://prometheus.io/docs/operating/security/>

collector/arp_linux.go

@@ -34,7 +34,7 @@ var (
 )
 
 type arpCollector struct {
-	deviceFilter netDevFilter
+	deviceFilter devFilter
 	entries      *prometheus.Desc
 	logger       log.Logger
 }
@@ -46,7 +46,7 @@ func init() {
 // NewARPCollector returns a new Collector exposing ARP stats.
 func NewARPCollector(logger log.Logger) (Collector, error) {
 	return &arpCollector{
-		deviceFilter: newNetDevFilter(*arpDeviceExclude, *arpDeviceInclude),
+		deviceFilter: newdevFilter(*arpDeviceExclude, *arpDeviceInclude),
 		entries: prometheus.NewDesc(
 			prometheus.BuildFQName(namespace, "arp", "entries"),
 			"ARP entries by device",

collector/diskstats_linux.go

@@ -17,9 +17,8 @@
 package collector
 
 import (
+	"errors"
 	"fmt"
-	"regexp"
-
 	"github.com/go-kit/log"
 	"github.com/go-kit/log/level"
 	"github.com/prometheus/client_golang/prometheus"
@@ -36,7 +35,9 @@ const (
 )
 
 var (
-	ignoredDevices = kingpin.Flag("collector.diskstats.ignored-devices", "Regexp of devices to ignore for diskstats.").Default("^(ram|loop|fd|(h|s|v|xv)d[a-z]|nvme\\d+n\\d+p)\\d+$").String()
+	diskstatsDeviceExclude    = kingpin.Flag("collector.diskstats.device-exclude", "Regexp of diskstats devices to exclude (mutually exclusive to device-include).").String()
+	oldDiskstatsDeviceExclude = kingpin.Flag("collector.diskstats.ignored-devices", "DEPRECATED: Use collector.diskstats.device-exclude").Default("^(ram|loop|fd|(h|s|v|xv)d[a-z]|nvme\\d+n\\d+p)\\d+$").Hidden().String()
+	diskstatsDeviceInclude    = kingpin.Flag("collector.diskstats.device-include", "Regexp of diskstats devices to include (mutually exclusive to device-exclude).").String()
 )
 
 type typedFactorDesc struct {
@@ -49,11 +50,11 @@ func (d *typedFactorDesc) mustNewConstMetric(value float64, labels ...string) pr
 }
 
 type diskstatsCollector struct {
-	ignoredDevicesPattern *regexp.Regexp
-	fs                    blockdevice.FS
-	infoDesc              typedFactorDesc
-	descs                 []typedFactorDesc
-	logger                log.Logger
+	deviceFilter devFilter
+	fs           blockdevice.FS
+	infoDesc     typedFactorDesc
+	descs        []typedFactorDesc
+	logger       log.Logger
 }
 
 func init() {
@@ -68,10 +69,30 @@ func NewDiskstatsCollector(logger log.Logger) (Collector, error) {
 	if err != nil {
 		return nil, fmt.Errorf("failed to open sysfs: %w", err)
 	}
+	if *oldDiskstatsDeviceExclude != "" {
+		if *diskstatsDeviceExclude == "" {
+			level.Warn(logger).Log("msg", "--collector.netdev.ignored-devices is DEPRECATED and will be removed in 2.0.0, use --collector.diskstats.device-exclude")
+			*diskstatsDeviceExclude = *oldDiskstatsDeviceExclude
+		} else {
+			return nil, errors.New("--collector.diskstats.ignored-devices and --collector.diskstats.device-exclude are mutually exclusive")
+		}
+	}
+
+	if *diskstatsDeviceExclude != "" && *diskstatsDeviceInclude != "" {
+		return nil, errors.New("device-exclude & device-include are mutually exclusive")
+	}
+
+	if *diskstatsDeviceExclude != "" {
+		level.Info(logger).Log("msg", "Parsed flag --collector.diskstats.device-exclude", "flag", *diskstatsDeviceExclude)
+	}
+
+	if *diskstatsDeviceInclude != "" {
+		level.Info(logger).Log("msg", "Parsed Flag --collector.diskstats.device-include", "flag", *diskstatsDeviceInclude)
+	}
 
 	return &diskstatsCollector{
-		ignoredDevicesPattern: regexp.MustCompile(*ignoredDevices),
-		fs:                    fs,
+		deviceFilter: newdevFilter(*diskstatsDeviceExclude, *diskstatsDeviceInclude),
+		fs:           fs,
 		infoDesc: typedFactorDesc{
 			desc: prometheus.NewDesc(prometheus.BuildFQName(namespace, diskSubsystem, "info"),
 				"Info of /sys/block/<block_device>.",
@@ -194,11 +215,9 @@ func (c *diskstatsCollector) Update(ch chan<- prometheus.Metric) error {
 
 	for _, stats := range diskStats {
 		dev := stats.DeviceName
-		if c.ignoredDevicesPattern.MatchString(dev) {
-			level.Debug(c.logger).Log("msg", "Ignoring device", "device", dev, "pattern", c.ignoredDevicesPattern)
+		if c.deviceFilter.ignored(dev) {
 			continue
 		}
-
 		ch <- c.infoDesc.mustNewConstMetric(1.0, dev, fmt.Sprint(stats.MajorNumber), fmt.Sprint(stats.MinorNumber))
 
 		statCount := stats.IoStatsCount - 3 // Total diskstats record count, less MajorNumber, MinorNumber and DeviceName
@@ -227,6 +246,7 @@ func (c *diskstatsCollector) Update(ch chan<- prometheus.Metric) error {
 			}
 			ch <- c.descs[i].mustNewConstMetric(val, dev)
 		}
+
 	}
 	return nil
 }

collector/ethtool_linux.go

@@ -76,7 +76,7 @@ type ethtoolCollector struct {
 	entries        map[string]*prometheus.Desc
 	entriesMutex   sync.Mutex
 	ethtool        Ethtool
-	deviceFilter   netDevFilter
+	deviceFilter   devFilter
 	infoDesc       *prometheus.Desc
 	metricsPattern *regexp.Regexp
 	logger         log.Logger
@@ -100,7 +100,7 @@ func makeEthtoolCollector(logger log.Logger) (*ethtoolCollector, error) {
 	return &ethtoolCollector{
 		fs:             fs,
 		ethtool:        &ethtoolLibrary{e},
-		deviceFilter:   newNetDevFilter(*ethtoolDeviceExclude, *ethtoolDeviceInclude),
+		deviceFilter:   newdevFilter(*ethtoolDeviceExclude, *ethtoolDeviceInclude),
 		metricsPattern: regexp.MustCompile(*ethtoolIncludedMetrics),
 		logger:         logger,
 		entries: map[string]*prometheus.Desc{

collector/netdev_bsd.go

@@ -34,7 +34,7 @@ import (
 */
 import "C"
 
-func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func getNetDevStats(filter *devFilter, logger log.Logger) (netDevStats, error) {
 	netDev := netDevStats{}
 
 	var ifap, ifa *C.struct_ifaddrs

collector/netdev_common.go

@@ -86,7 +86,7 @@ func NewNetDevCollector(logger log.Logger) (Collector, error) {
 
 	return &netDevCollector{
 		subsystem:    "network",
-		deviceFilter: newNetDevFilter(*netdevDeviceExclude, *netdevDeviceInclude),
+		deviceFilter: newdevFilter(*netdevDeviceExclude, *netdevDeviceInclude),
 		metricDescs:  map[string]*prometheus.Desc{},
 		logger:       logger,
 	}, nil

collector/netdev_darwin.go

@@ -27,7 +27,7 @@ import (
 	"golang.org/x/sys/unix"
 )
 
-func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func getNetDevStats(filter *devFilter, logger log.Logger) (netDevStats, error) {
 	netDev := netDevStats{}
 
 	ifs, err := net.Interfaces()

collector/netdev_filter.go

@@ -17,12 +17,12 @@ import (
 	"regexp"
 )
 
-type netDevFilter struct {
+type devFilter struct {
 	ignorePattern *regexp.Regexp
 	acceptPattern *regexp.Regexp
 }
 
-func newNetDevFilter(ignoredPattern, acceptPattern string) (f netDevFilter) {
+func newdevFilter(ignoredPattern, acceptPattern string) (f devFilter) {
 	if ignoredPattern != "" {
 		f.ignorePattern = regexp.MustCompile(ignoredPattern)
 	}
@@ -35,7 +35,7 @@ func newNetDevFilter(ignoredPattern, acceptPattern string) (f netDevFilter) {
 }
 
 // ignores returns whether the device should be ignored
-func (f *netDevFilter) ignored(name string) bool {
+func (f *devFilter) ignored(name string) bool {
 	return ((f.ignorePattern != nil && f.ignorePattern.MatchString(name)) ||
 		(f.acceptPattern != nil && !f.acceptPattern.MatchString(name)))
 }

collector/netdev_filter_test.go

@@ -17,7 +17,7 @@ import (
 	"testing"
 )
 
-func TestNetDevFilter(t *testing.T) {
+func TestdevFilter(t *testing.T) {
 	tests := []struct {
 		ignore         string
 		accept         string
@@ -33,7 +33,7 @@ func TestNetDevFilter(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		filter := newNetDevFilter(test.ignore, test.accept)
+		filter := newdevFilter(test.ignore, test.accept)
 		result := filter.ignored(test.name)
 
 		if result != test.expectedResult {

collector/netdev_linux.go

@@ -34,7 +34,7 @@ var (
 	procNetDevFieldSep    = regexp.MustCompile(` +`)
 )
 
-func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func getNetDevStats(filter *devFilter, logger log.Logger) (netDevStats, error) {
 	file, err := os.Open(procFilePath("net/dev"))
 	if err != nil {
 		return nil, err
@@ -44,7 +44,7 @@ func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error
 	return parseNetDevStats(file, filter, logger)
 }
 
-func parseNetDevStats(r io.Reader, filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func parseNetDevStats(r io.Reader, filter *devFilter, logger log.Logger) (netDevStats, error) {
 	scanner := bufio.NewScanner(r)
 	scanner.Scan() // skip first header
 	scanner.Scan()

collector/netdev_linux_test.go

@@ -27,7 +27,7 @@ func TestNetDevStatsIgnore(t *testing.T) {
 	}
 	defer file.Close()
 
-	filter := newNetDevFilter("^veth", "")
+	filter := newdevFilter("^veth", "")
 
 	netStats, err := parseNetDevStats(file, &filter, log.NewNopLogger())
 	if err != nil {
@@ -70,7 +70,7 @@ func TestNetDevStatsAccept(t *testing.T) {
 	}
 	defer file.Close()
 
-	filter := newNetDevFilter("", "^💩0$")
+	filter := newdevFilter("", "^💩0$")
 	netStats, err := parseNetDevStats(file, &filter, log.NewNopLogger())
 	if err != nil {
 		t.Fatal(err)

collector/netdev_openbsd.go

@@ -31,7 +31,7 @@ import (
 */
 import "C"
 
-func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func getNetDevStats(filter *devFilter, logger log.Logger) (netDevStats, error) {
 	netDev := netDevStats{}
 
 	var ifap, ifa *C.struct_ifaddrs

collector/netdev_openbsd_amd64.go

@@ -24,7 +24,7 @@ import (
 	"unsafe"
 )
 
-func getNetDevStats(filter *netDevFilter, logger log.Logger) (netDevStats, error) {
+func getNetDevStats(filter *devFilter, logger log.Logger) (netDevStats, error) {
 	netDev := netDevStats{}
 
 	mib := [6]_C_int{unix.CTL_NET, unix.AF_ROUTE, 0, 0, unix.NET_RT_IFLIST, 0}