Refactor collectors

Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>

pkg/collector/fsrmquota/fsrmquota.go

@@ -0,0 +1,218 @@
+//go:build windows
+
+package fsrmquota
+
+import (
+	"github.com/prometheus-community/windows_exporter/pkg/types"
+	"github.com/prometheus-community/windows_exporter/pkg/utils"
+	"github.com/prometheus-community/windows_exporter/pkg/wmi"
+
+	"github.com/alecthomas/kingpin/v2"
+	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+const Name = "fsrmquota"
+
+type Config struct{}
+
+var ConfigDefaults = Config{}
+
+type collector struct {
+	logger log.Logger
+
+	QuotasCount *prometheus.Desc
+	Path        *prometheus.Desc
+	PeakUsage   *prometheus.Desc
+	Size        *prometheus.Desc
+	Usage       *prometheus.Desc
+
+	Description     *prometheus.Desc
+	Disabled        *prometheus.Desc
+	MatchesTemplate *prometheus.Desc
+	SoftLimit       *prometheus.Desc
+	Template        *prometheus.Desc
+}
+
+func New(logger log.Logger, _ *Config) types.Collector {
+	c := &collector{}
+	c.SetLogger(logger)
+	return c
+}
+
+func NewWithFlags(_ *kingpin.Application) types.Collector {
+	return &collector{}
+}
+
+func (c *collector) GetName() string {
+	return Name
+}
+
+func (c *collector) SetLogger(logger log.Logger) {
+	c.logger = log.With(logger, "collector", Name)
+}
+
+func (c *collector) GetPerfCounter() ([]string, error) {
+	return []string{}, nil
+}
+
+func (c *collector) Build() error {
+	c.QuotasCount = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "count"),
+		"Number of Quotas",
+		nil,
+		nil,
+	)
+	c.PeakUsage = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "peak_usage_bytes"),
+		"The highest amount of disk space usage charged to this quota. (PeakUsage)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.Size = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "size_bytes"),
+		"The size of the quota. (Size)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.Usage = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "usage_bytes"),
+		"The current amount of disk space usage charged to this quota. (Usage)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.Description = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "description"),
+		"Description of the quota (Description)",
+		[]string{"path", "template", "description"},
+		nil,
+	)
+	c.Disabled = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "disabled"),
+		"If 1, the quota is disabled. The default value is 0. (Disabled)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.SoftLimit = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "softlimit"),
+		"If 1, the quota is a soft limit. If 0, the quota is a hard limit. The default value is 0. Optional (SoftLimit)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.Template = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "template"),
+		"Quota template name. (Template)",
+		[]string{"path", "template"},
+		nil,
+	)
+	c.MatchesTemplate = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "matchestemplate"),
+		"If 1, the property values of this quota match those values of the template from which it was derived. (MatchesTemplate)",
+		[]string{"path", "template"},
+		nil,
+	)
+	return nil
+}
+
+// Collect sends the metric values for each metric
+// to the provided prometheus Metric channel.
+func (c *collector) Collect(_ *types.ScrapeContext, ch chan<- prometheus.Metric) error {
+	if desc, err := c.collect(ch); err != nil {
+		_ = level.Error(c.logger).Log("msg", "failed collecting fsrmquota metrics", "desc", desc, "err", err)
+		return err
+	}
+	return nil
+}
+
+// MSFT_FSRMQuota docs:
+// https://docs.microsoft.com/en-us/previous-versions/windows/desktop/fsrm/msft-fsrmquota
+type MSFT_FSRMQuota struct {
+	Name string
+
+	Path        string
+	PeakUsage   uint64
+	Size        uint64
+	Usage       uint64
+	Description string
+	Template    string
+	// Threshold             string
+	Disabled        bool
+	MatchesTemplate bool
+	SoftLimit       bool
+}
+
+func (c *collector) collect(ch chan<- prometheus.Metric) (*prometheus.Desc, error) {
+	var dst []MSFT_FSRMQuota
+	q := wmi.QueryAll(&dst, c.logger)
+
+	var count int
+
+	if err := wmi.QueryNamespace(q, &dst, "root/microsoft/windows/fsrm"); err != nil {
+		return nil, err
+	}
+
+	for _, quota := range dst {
+
+		count++
+		path := quota.Path
+		template := quota.Template
+		Description := quota.Description
+
+		ch <- prometheus.MustNewConstMetric(
+			c.PeakUsage,
+			prometheus.GaugeValue,
+			float64(quota.PeakUsage),
+			path,
+			template,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.Size,
+			prometheus.GaugeValue,
+			float64(quota.Size),
+			path,
+			template,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.Usage,
+			prometheus.GaugeValue,
+			float64(quota.Usage),
+			path,
+			template,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.Description,
+			prometheus.GaugeValue,
+			1.0,
+			path, template, Description,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.Disabled,
+			prometheus.GaugeValue,
+			utils.BoolToFloat(quota.Disabled),
+			path,
+			template,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.MatchesTemplate,
+			prometheus.GaugeValue,
+			utils.BoolToFloat(quota.MatchesTemplate),
+			path,
+			template,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.SoftLimit,
+			prometheus.GaugeValue,
+			utils.BoolToFloat(quota.SoftLimit),
+			path,
+			template,
+		)
+	}
+
+	ch <- prometheus.MustNewConstMetric(
+		c.QuotasCount,
+		prometheus.GaugeValue,
+		float64(count),
+	)
+	return nil, nil
+}

pkg/collector/fsrmquota/fsrmquota_test.go

@@ -0,0 +1,12 @@
+package fsrmquota_test
+
+import (
+	"testing"
+
+	"github.com/prometheus-community/windows_exporter/pkg/collector/fsrmquota"
+	"github.com/prometheus-community/windows_exporter/pkg/testutils"
+)
+
+func BenchmarkCollector(b *testing.B) {
+	testutils.FuncBenchmarkCollector(b, fsrmquota.Name, fsrmquota.NewWithFlags)
+}