Refactor collectors

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

pkg/collector/netframework_clrremoting/netframework_clrremoting.go

@@ -0,0 +1,173 @@
+//go:build windows
+
+package netframework_clrremoting
+
+import (
+	"github.com/alecthomas/kingpin/v2"
+	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
+	"github.com/prometheus-community/windows_exporter/pkg/types"
+	"github.com/prometheus-community/windows_exporter/pkg/wmi"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+const Name = "netframework_clrremoting"
+
+type Config struct{}
+
+var ConfigDefaults = Config{}
+
+// A collector is a Prometheus collector for WMI Win32_PerfRawData_NETFramework_NETCLRRemoting metrics
+type collector struct {
+	logger log.Logger
+
+	Channels                  *prometheus.Desc
+	ContextBoundClassesLoaded *prometheus.Desc
+	ContextBoundObjects       *prometheus.Desc
+	ContextProxies            *prometheus.Desc
+	Contexts                  *prometheus.Desc
+	TotalRemoteCalls          *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.Channels = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "channels_total"),
+		"Displays the total number of remoting channels registered across all application domains since application started.",
+		[]string{"process"},
+		nil,
+	)
+	c.ContextBoundClassesLoaded = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "context_bound_classes_loaded"),
+		"Displays the current number of context-bound classes that are loaded.",
+		[]string{"process"},
+		nil,
+	)
+	c.ContextBoundObjects = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "context_bound_objects_total"),
+		"Displays the total number of context-bound objects allocated.",
+		[]string{"process"},
+		nil,
+	)
+	c.ContextProxies = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "context_proxies_total"),
+		"Displays the total number of remoting proxy objects in this process since it started.",
+		[]string{"process"},
+		nil,
+	)
+	c.Contexts = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "contexts"),
+		"Displays the current number of remoting contexts in the application.",
+		[]string{"process"},
+		nil,
+	)
+	c.TotalRemoteCalls = prometheus.NewDesc(
+		prometheus.BuildFQName(types.Namespace, Name, "remote_calls_total"),
+		"Displays the total number of remote procedure calls invoked since the application started.",
+		[]string{"process"},
+		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 win32_perfrawdata_netframework_netclrremoting metrics", "desc", desc, "err", err)
+		return err
+	}
+	return nil
+}
+
+type Win32_PerfRawData_NETFramework_NETCLRRemoting struct {
+	Name string
+
+	Channels                       uint32
+	ContextBoundClassesLoaded      uint32
+	ContextBoundObjectsAllocPersec uint32
+	ContextProxies                 uint32
+	Contexts                       uint32
+	RemoteCallsPersec              uint32
+	TotalRemoteCalls               uint32
+}
+
+func (c *collector) collect(ch chan<- prometheus.Metric) (*prometheus.Desc, error) {
+	var dst []Win32_PerfRawData_NETFramework_NETCLRRemoting
+	q := wmi.QueryAll(&dst, c.logger)
+	if err := wmi.Query(q, &dst); err != nil {
+		return nil, err
+	}
+
+	for _, process := range dst {
+
+		if process.Name == "_Global_" {
+			continue
+		}
+
+		ch <- prometheus.MustNewConstMetric(
+			c.Channels,
+			prometheus.CounterValue,
+			float64(process.Channels),
+			process.Name,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.ContextBoundClassesLoaded,
+			prometheus.GaugeValue,
+			float64(process.ContextBoundClassesLoaded),
+			process.Name,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.ContextBoundObjects,
+			prometheus.CounterValue,
+			float64(process.ContextBoundObjectsAllocPersec),
+			process.Name,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.ContextProxies,
+			prometheus.CounterValue,
+			float64(process.ContextProxies),
+			process.Name,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.Contexts,
+			prometheus.GaugeValue,
+			float64(process.Contexts),
+			process.Name,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.TotalRemoteCalls,
+			prometheus.CounterValue,
+			float64(process.TotalRemoteCalls),
+			process.Name,
+		)
+	}
+
+	return nil, nil
+}

pkg/collector/netframework_clrremoting/netframework_clrremoting_test.go

@@ -0,0 +1,13 @@
+package netframework_clrremoting_test
+
+import (
+	"testing"
+
+	"github.com/prometheus-community/windows_exporter/pkg/collector/netframework_clrremoting"
+	"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, netframework_clrremoting.Name, netframework_clrremoting.NewWithFlags)
+}