Add benchmark for each collector

Benchmarks will allow for easier identification of slow collectors.
Additionally, they increase test coverage of the collectors, with some
collectors now reaching 80-95% coverage with this change.

Collector benchmarks have been structed so that common functionality is
present in `collector/collector_test.go` as is done with non-test
functionality in `collector/collector.go`.
Test logic that is specific to individual collectors is present in the
collector test file (E.G. `collector/process_test.go` for the Process
collector).

Signed-off-by: Ben Reedy <breed808@breed808.com>

Makefile

@@ -8,6 +8,9 @@ windows_exporter.exe: **/*.go
 test:
 	go test -v ./...
 
+bench:
+	go test -v -bench='benchmark(cpu|logicaldisk|logon|memory|net|process|service|system|tcp|time)collector' ./...
+
 lint:
 	golangci-lint -c .golangci.yaml run
 

collector/ad_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkADCollector(b *testing.B) {
+	benchmarkCollector(b, "ad", NewADCollector)
+}

collector/adfs_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkADFSCollector(b *testing.B) {
+	benchmarkCollector(b, "adfs", newADFSCollector)
+}

collector/collector_test.go

@@ -3,6 +3,8 @@ package collector
 import (
 	"reflect"
 	"testing"
+
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 func TestExpandChildCollectors(t *testing.T) {
@@ -32,3 +34,27 @@ func TestExpandChildCollectors(t *testing.T) {
 		})
 	}
 }
+
+func benchmarkCollector(b *testing.B, name string, collectFunc func() (Collector, error)) {
+	// Create perflib scrape context. Some perflib collectors required a correct context,
+	// or will fail during benchmark.
+	scrapeContext, err := PrepareScrapeContext([]string{name})
+	if err != nil {
+		b.Error(err)
+	}
+	c, err := collectFunc()
+	if err != nil {
+		b.Error(err)
+	}
+
+	metrics := make(chan prometheus.Metric)
+	go func() {
+		for {
+			<-metrics
+		}
+	}()
+
+	for i := 0; i < b.N; i++ {
+		c.Collect(scrapeContext, metrics)
+	}
+}

collector/container_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkContainerCollector(b *testing.B) {
+	benchmarkCollector(b, "container", NewContainerMetricsCollector)
+}

collector/cpu_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkCPUCollector(b *testing.B) {
+	benchmarkCollector(b, "cpu", newCPUCollector)
+}

collector/cs_test.go

@@ -2,22 +2,8 @@ package collector
 
 import (
 	"testing"
-
-	"github.com/prometheus/client_golang/prometheus"
 )
 
-func BenchmarkCsCollect(b *testing.B) {
+func BenchmarkCsCollector(b *testing.B) {
-	c, err := NewCSCollector()
+	benchmarkCollector(b, "cs", NewCSCollector)
-	if err != nil {
-		b.Error(err)
-	}
-	metrics := make(chan prometheus.Metric)
-	go func() {
-		for {
-			<-metrics
-		}
-	}()
-	for i := 0; i < b.N; i++ {
-		c.Collect(&ScrapeContext{}, metrics)
-	}
 }

collector/dfsr_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkDFSRCollector(b *testing.B) {
+	benchmarkCollector(b, "dfsr", NewDFSRCollector)
+}

collector/dhcp_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkDHCPCollector(b *testing.B) {
+	benchmarkCollector(b, "dhcp", NewDhcpCollector)
+}

collector/dns_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkDNSCollector(b *testing.B) {
+	benchmarkCollector(b, "dns", NewDNSCollector)
+}

collector/exchange_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkExchangeCollector(b *testing.B) {
+	benchmarkCollector(b, "exchange", newExchangeCollector)
+}

collector/fsrmquota_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkFsrmQuotaCollector(b *testing.B) {
+	benchmarkCollector(b, "fsrmquota", newFSRMQuotaCollector)
+}

collector/hyperv_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkHypervCollector(b *testing.B) {
+	benchmarkCollector(b, "hyperv", NewHyperVCollector)
+}

collector/iis_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkIISCollector(b *testing.B) {
+	benchmarkCollector(b, "iis", NewIISCollector)
+}

collector/logical_disk_test.go

@@ -0,0 +1,13 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkLogicalDiskCollector(b *testing.B) {
+	// Whitelist is not set in testing context (kingpin flags not parsed), causing the collector to skip all disks.
+	localVolumeWhitelist := ".+"
+	volumeWhitelist = &localVolumeWhitelist
+
+	benchmarkCollector(b, "logical_disk", NewLogicalDiskCollector)
+}

collector/logon_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkLogonCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewLogonCollector)
+}

collector/memory_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkMemoryCollector(b *testing.B) {
+	benchmarkCollector(b, "memory", NewMemoryCollector)
+}

collector/msmq_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkMsmqCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewMSMQCollector)
+}

collector/mssql_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkMSSQLCollector(b *testing.B) {
+	benchmarkCollector(b, "mssql", NewMSSQLCollector)
+}

collector/net_test.go

@@ -2,7 +2,9 @@
 
 package collector
 
-import "testing"
+import (
+	"testing"
+)
 
 func TestNetworkToInstanceName(t *testing.T) {
 	data := map[string]string{
@@ -15,3 +17,10 @@ func TestNetworkToInstanceName(t *testing.T) {
 		}
 	}
 }
+
+func BenchmarkNetCollector(b *testing.B) {
+	// Whitelist is not set in testing context (kingpin flags not parsed), causing the collector to skip all interfaces.
+	localNicWhitelist := ".+"
+	nicWhitelist = &localNicWhitelist
+	benchmarkCollector(b, "net", NewNetworkCollector)
+}

collector/netframework_clrexceptions_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNetFrameworkNETCLRExceptionsCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRExceptionsCollector)
+}

collector/netframework_clrinterop_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRInteropCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRInteropCollector)
+}

collector/netframework_clrjit_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRJitCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRJitCollector)
+}

collector/netframework_clrloading_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRLoadingCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRLoadingCollector)
+}

collector/netframework_clrlocksandthreads_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRLocksAndThreadsCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRLocksAndThreadsCollector)
+}

collector/netframework_clrmemory_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRMemoryCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRMemoryCollector)
+}

collector/netframework_clrremoting_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRRemotingCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRRemotingCollector)
+}

collector/netframework_clrsecurity_test.go

@@ -0,0 +1,10 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkNETFrameworkNETCLRSecurityCollector(b *testing.B) {
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", NewNETFramework_NETCLRSecurityCollector)
+}

collector/os_test.go

@@ -2,23 +2,8 @@ package collector
 
 import (
 	"testing"
-
-	"github.com/prometheus/client_golang/prometheus"
 )
 
-func BenchmarkOsCollect(b *testing.B) {
+func BenchmarkOSCollector(b *testing.B) {
-	o, err := NewOSCollector()
+	benchmarkCollector(b, "os", NewOSCollector)
-	if err != nil {
-		b.Error(err)
-	}
-	metrics := make(chan prometheus.Metric)
-	go func() {
-		for {
-			<-metrics
-		}
-	}()
-	s, err := PrepareScrapeContext([]string{"os"})
-	for i := 0; i < b.N; i++ {
-		o.Collect(s, metrics)
-	}
 }

collector/process_test.go

@@ -0,0 +1,14 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkProcessCollector(b *testing.B) {
+	// Whitelist is not set in testing context (kingpin flags not parsed), causing the collector to skip all processes.
+	localProcessWhitelist := ".+"
+	processWhitelist = &localProcessWhitelist
+
+	// No context name required as collector source is WMI
+	benchmarkCollector(b, "", newProcessCollector)
+}

collector/remote_fx_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkRemoteFXCollector(b *testing.B) {
+	benchmarkCollector(b, "remote_fx", NewRemoteFx)
+}

collector/service_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkServiceCollector(b *testing.B) {
+	benchmarkCollector(b, "service", NewserviceCollector)
+}

collector/smtp_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkSmtpCollector(b *testing.B) {
+	benchmarkCollector(b, "smtp", NewSMTPCollector)
+}

collector/system_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkSystemCollector(b *testing.B) {
+	benchmarkCollector(b, "system", NewSystemCollector)
+}

collector/tcp_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkTCPCollector(b *testing.B) {
+	benchmarkCollector(b, "tcp", NewTCPCollector)
+}

collector/terminal_services_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkTerminalServicesCollector(b *testing.B) {
+	benchmarkCollector(b, "terminal_services", NewTerminalServicesCollector)
+}

collector/thermalzone_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkThermalZoneCollector(b *testing.B) {
+	benchmarkCollector(b, "thermalzone", NewThermalZoneCollector)
+}

collector/time_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkTimeCollector(b *testing.B) {
+	benchmarkCollector(b, "time", newTimeCollector)
+}

collector/vmware_test.go

@@ -0,0 +1,9 @@
+package collector
+
+import (
+	"testing"
+)
+
+func BenchmarkVmwareCollector(b *testing.B) {
+	benchmarkCollector(b, "vmware", NewVmwareCollector)
+}