*: cleanup collector API 1 (#1547)

pkg/collector/netframework_clrexceptions/netframework_clrexceptions.go

@@ -3,12 +3,11 @@
 package netframework_clrexceptions
 
 import (
-	"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-community/windows_exporter/pkg/types"
+	"github.com/prometheus-community/windows_exporter/pkg/wmi"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
@@ -18,52 +17,57 @@ type Config struct{}
 
 var ConfigDefaults = Config{}
 
-// A collector is a Prometheus collector for WMI Win32_PerfRawData_NETFramework_NETCLRExceptions metrics
-type collector struct {
+// A Collector is a Prometheus Collector for WMI Win32_PerfRawData_NETFramework_NETCLRExceptions metrics
+type Collector struct {
 	logger log.Logger
 
-	NumberofExcepsThrown *prometheus.Desc
-	NumberofFilters      *prometheus.Desc
-	NumberofFinallys     *prometheus.Desc
-	ThrowToCatchDepth    *prometheus.Desc
+	NumberOfExceptionsThrown *prometheus.Desc
+	NumberOfFilters          *prometheus.Desc
+	NumberOfFinally          *prometheus.Desc
+	ThrowToCatchDepth        *prometheus.Desc
 }
 
-func New(logger log.Logger, _ *Config) types.Collector {
-	c := &collector{}
+func New(logger log.Logger, _ *Config) *Collector {
+	c := &Collector{}
 	c.SetLogger(logger)
+
 	return c
 }
 
-func NewWithFlags(_ *kingpin.Application) types.Collector {
-	return &collector{}
+func NewWithFlags(_ *kingpin.Application) *Collector {
+	return &Collector{}
 }
 
-func (c *collector) GetName() string {
+func (c *Collector) GetName() string {
 	return Name
 }
 
-func (c *collector) SetLogger(logger log.Logger) {
+func (c *Collector) SetLogger(logger log.Logger) {
 	c.logger = log.With(logger, "collector", Name)
 }
 
-func (c *collector) GetPerfCounter() ([]string, error) {
+func (c *Collector) GetPerfCounter() ([]string, error) {
 	return []string{}, nil
 }
 
-func (c *collector) Build() error {
-	c.NumberofExcepsThrown = prometheus.NewDesc(
+func (c *Collector) Close() error {
+	return nil
+}
+
+func (c *Collector) Build() error {
+	c.NumberOfExceptionsThrown = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "exceptions_thrown_total"),
 		"Displays the total number of exceptions thrown since the application started. This includes both .NET exceptions and unmanaged exceptions that are converted into .NET exceptions.",
 		[]string{"process"},
 		nil,
 	)
-	c.NumberofFilters = prometheus.NewDesc(
+	c.NumberOfFilters = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "exceptions_filters_total"),
 		"Displays the total number of .NET exception filters executed. An exception filter evaluates regardless of whether an exception is handled.",
 		[]string{"process"},
 		nil,
 	)
-	c.NumberofFinallys = prometheus.NewDesc(
+	c.NumberOfFinally = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "exceptions_finallys_total"),
 		"Displays the total number of finally blocks executed. Only the finally blocks executed for an exception are counted; finally blocks on normal code paths are not counted by this counter.",
 		[]string{"process"},
@@ -80,7 +84,7 @@ func (c *collector) Build() error {
 
 // 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 {
+func (c *Collector) Collect(_ *types.ScrapeContext, ch chan<- prometheus.Metric) error {
 	if err := c.collect(ch); err != nil {
 		_ = level.Error(c.logger).Log("msg", "failed collecting win32_perfrawdata_netframework_netclrexceptions metrics", "err", err)
 		return err
@@ -98,7 +102,7 @@ type Win32_PerfRawData_NETFramework_NETCLRExceptions struct {
 	ThrowToCatchDepthPersec    uint32
 }
 
-func (c *collector) collect(ch chan<- prometheus.Metric) error {
+func (c *Collector) collect(ch chan<- prometheus.Metric) error {
 	var dst []Win32_PerfRawData_NETFramework_NETCLRExceptions
 	q := wmi.QueryAll(&dst, c.logger)
 	if err := wmi.Query(q, &dst); err != nil {
@@ -106,27 +110,26 @@ func (c *collector) collect(ch chan<- prometheus.Metric) error {
 	}
 
 	for _, process := range dst {
-
 		if process.Name == "_Global_" {
 			continue
 		}
 
 		ch <- prometheus.MustNewConstMetric(
-			c.NumberofExcepsThrown,
+			c.NumberOfExceptionsThrown,
 			prometheus.CounterValue,
 			float64(process.NumberofExcepsThrown),
 			process.Name,
 		)
 
 		ch <- prometheus.MustNewConstMetric(
-			c.NumberofFilters,
+			c.NumberOfFilters,
 			prometheus.CounterValue,
 			float64(process.NumberofFiltersPersec),
 			process.Name,
 		)
 
 		ch <- prometheus.MustNewConstMetric(
-			c.NumberofFinallys,
+			c.NumberOfFinally,
 			prometheus.CounterValue,
 			float64(process.NumberofFinallysPersec),
 			process.Name,

pkg/collector/netframework_clrexceptions/netframework_clrexceptions_test.go

@@ -8,6 +8,6 @@ import (
 )
 
 func BenchmarkCollector(b *testing.B) {
-	// No context name required as collector source is WMI
+	// No context name required as Collector source is WMI
 	testutils.FuncBenchmarkCollector(b, netframework_clrexceptions.Name, netframework_clrexceptions.NewWithFlags)
 }