Refactor collectors

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

pkg/collector/msmq/msmq.go

@@ -0,0 +1,162 @@
+//go:build windows
+
+package msmq
+
+import (
+	"strings"
+
+	"github.com/prometheus-community/windows_exporter/pkg/types"
+	"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                = "msmq"
+	FlagMsmqWhereClause = "collector.msmq.msmq-where"
+)
+
+type Config struct {
+	QueryWhereClause string `yaml:"query_where_clause"`
+}
+
+var ConfigDefaults = Config{
+	QueryWhereClause: "",
+}
+
+// A collector is a Prometheus collector for WMI Win32_PerfRawData_MSMQ_MSMQQueue metrics
+type collector struct {
+	logger log.Logger
+
+	queryWhereClause *string
+
+	BytesinJournalQueue    *prometheus.Desc
+	BytesinQueue           *prometheus.Desc
+	MessagesinJournalQueue *prometheus.Desc
+	MessagesinQueue        *prometheus.Desc
+}
+
+func New(logger log.Logger, config *Config) types.Collector {
+	if config == nil {
+		config = &ConfigDefaults
+	}
+
+	c := &collector{
+		queryWhereClause: &config.QueryWhereClause,
+	}
+	c.SetLogger(logger)
+	return c
+}
+
+func NewWithFlags(app *kingpin.Application) types.Collector {
+	return &collector{
+		queryWhereClause: app.
+			Flag(FlagMsmqWhereClause, "WQL 'where' clause to use in WMI metrics query. Limits the response to the msmqs you specify and reduces the size of the response.").
+			Default(ConfigDefaults.QueryWhereClause).String(),
+	}
+}
+
+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 {
+	if *c.queryWhereClause == "" {
+		_ = level.Warn(c.logger).Log("msg", "No where-clause specified for msmq collector. This will generate a very large number of metrics!")
+	}
+
+	c.BytesinJournalQueue = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "bytes_in_journal_queue"),
+		"Size of queue journal in bytes",
+		[]string{"name"},
+		nil,
+	)
+	c.BytesinQueue = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "bytes_in_queue"),
+		"Size of queue in bytes",
+		[]string{"name"},
+		nil,
+	)
+	c.MessagesinJournalQueue = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "messages_in_journal_queue"),
+		"Count messages in queue journal",
+		[]string{"name"},
+		nil,
+	)
+	c.MessagesinQueue = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "messages_in_queue"),
+		"Count messages in queue",
+		[]string{"name"},
+		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("failed collecting msmq metrics", "desc", desc, "err", err)
+		return err
+	}
+	return nil
+}
+
+type Win32_PerfRawData_MSMQ_MSMQQueue struct {
+	Name string
+
+	BytesinJournalQueue    uint64
+	BytesinQueue           uint64
+	MessagesinJournalQueue uint64
+	MessagesinQueue        uint64
+}
+
+func (c *collector) collect(ch chan<- prometheus.Metric) (*prometheus.Desc, error) {
+	var dst []Win32_PerfRawData_MSMQ_MSMQQueue
+	q := wmi.QueryAllWhere(&dst, *c.queryWhereClause, c.logger)
+	if err := wmi.Query(q, &dst); err != nil {
+		return nil, err
+	}
+
+	for _, msmq := range dst {
+		ch <- prometheus.MustNewConstMetric(
+			c.BytesinJournalQueue,
+			prometheus.GaugeValue,
+			float64(msmq.BytesinJournalQueue),
+			strings.ToLower(msmq.Name),
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.BytesinQueue,
+			prometheus.GaugeValue,
+			float64(msmq.BytesinQueue),
+			strings.ToLower(msmq.Name),
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.MessagesinJournalQueue,
+			prometheus.GaugeValue,
+			float64(msmq.MessagesinJournalQueue),
+			strings.ToLower(msmq.Name),
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.MessagesinQueue,
+			prometheus.GaugeValue,
+			float64(msmq.MessagesinQueue),
+			strings.ToLower(msmq.Name),
+		)
+	}
+	return nil, nil
+}

pkg/collector/msmq/msmq_test.go

@@ -0,0 +1,13 @@
+package msmq_test
+
+import (
+	"testing"
+
+	"github.com/prometheus-community/windows_exporter/pkg/collector/msmq"
+	"github.com/prometheus-community/windows_exporter/pkg/testutils"
+)
+
+func BenchmarkCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	testutils.FuncBenchmarkCollector(b, msmq.Name, msmq.NewWithFlags)
+}