chore: remove replace (#1628)

.golangci.yaml

@@ -45,9 +45,6 @@ linters-settings:
         # Support string case: `camel`, `pascal`, `kebab`, `snake`, `upperSnake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`, `header`
         json: camel
         yaml: snake
-  gomoddirectives:
-    replace-allow-list:
-      - github.com/prometheus/common # https://github.com/prometheus/common/pull/694
   forbidigo:
     forbid:
       - "^(fmt\\.Print(|f|ln)|print|println)$"

docs/collector.service.md

@@ -72,20 +72,20 @@ windows_service_start_mode{name="dcsvc",start_mode="manual"} 1
 windows_service_start_mode{name="dcsvc",start_mode="system"} 0
 # HELP windows_service_state The state of the service (State)
 # TYPE windows_service_state gauge
-windows_service_state{name="Themes",status="continue pending"} 0
-windows_service_state{name="Themes",status="pause pending"} 0
-windows_service_state{name="Themes",status="paused"} 0
-windows_service_state{name="Themes",status="running"} 1
-windows_service_state{name="Themes",status="start pending"} 0
-windows_service_state{name="Themes",status="stop pending"} 0
-windows_service_state{name="Themes",status="stopped"} 0
-windows_service_state{name="dcsvc",status="continue pending"} 0
-windows_service_state{name="dcsvc",status="pause pending"} 0
-windows_service_state{name="dcsvc",status="paused"} 0
-windows_service_state{name="dcsvc",status="running"} 0
-windows_service_state{name="dcsvc",status="start pending"} 0
-windows_service_state{name="dcsvc",status="stop pending"} 0
-windows_service_state{name="dcsvc",status="stopped"} 1
+windows_service_state{name="Themes",state="continue pending"} 0
+windows_service_state{name="Themes",state="pause pending"} 0
+windows_service_state{name="Themes",state="paused"} 0
+windows_service_state{name="Themes",state="running"} 1
+windows_service_state{name="Themes",state="start pending"} 0
+windows_service_state{name="Themes",state="stop pending"} 0
+windows_service_state{name="Themes",state="stopped"} 0
+windows_service_state{name="dcsvc",state="continue pending"} 0
+windows_service_state{name="dcsvc",state="pause pending"} 0
+windows_service_state{name="dcsvc",state="paused"} 0
+windows_service_state{name="dcsvc",state="running"} 0
+windows_service_state{name="dcsvc",state="start pending"} 0
+windows_service_state{name="dcsvc",state="stop pending"} 0
+windows_service_state{name="dcsvc",state="stopped"} 1
 ```
 
 ## Useful queries

exporter.go

@@ -217,6 +217,10 @@ func run() int {
 
 	logger.Info("Enabled collectors: " + strings.Join(enabledCollectorList, ", "))
 
+	if utils.PDHEnabled() {
+		logger.Info("Using performance data helper from PHD.dll for performance counter collection. This is in experimental state.")
+	}
+
 	mux := http.NewServeMux()
 	mux.Handle("GET /health", httphandler.NewHealthHandler())
 	mux.Handle("GET /version", httphandler.NewVersionHandler())

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/prometheus/client_golang v1.20.3
 	github.com/prometheus/client_model v0.6.1
-	github.com/prometheus/common v0.59.1
+	github.com/prometheus/common v0.59.2-0.20240914165825-40d6251261f7
 	github.com/prometheus/exporter-toolkit v0.13.0
 	github.com/stretchr/testify v1.9.0
 	github.com/yusufpapurcu/wmi v1.2.4
@@ -46,10 +46,7 @@ require (
 	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/text v0.18.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 // indirect
-	google.golang.org/grpc v1.66.0 // indirect
+	google.golang.org/grpc v1.66.2 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
-
-// https://github.com/prometheus/common/pull/694
-replace github.com/prometheus/common v0.59.1 => github.com/jkroepke/prometheus-common v0.0.0-20240907211841-5f9af24b97ad

go.sum

@@ -59,8 +59,6 @@ github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeN
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/jkroepke/prometheus-common v0.0.0-20240907211841-5f9af24b97ad h1:sFDfDs4nDXjES8PdrFPiXeYt8dtaxn10M/Ebxe4IuiI=
-github.com/jkroepke/prometheus-common v0.0.0-20240907211841-5f9af24b97ad/go.mod h1:GpWM7dewqmVYcd7SmRaiWVe9SSqjf0UrwnYnpEZNuT0=
 github.com/jpillora/backoff v1.0.0 h1:uvFg412JmmHBHw7iwprIxkPMI+sGQ4kzOWsMeHnm2EA=
 github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4=
 github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
@@ -88,6 +86,8 @@ github.com/prometheus/client_golang v1.20.3/go.mod h1:PIEt8X02hGcP8JWbeHyeZ53Y/j
 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
 github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E=
 github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY=
+github.com/prometheus/common v0.59.2-0.20240914165825-40d6251261f7 h1:DT3yUDP5XHbLdx1oY1xmEn0i/Ze6R2tLO3Q8QBBObEk=
+github.com/prometheus/common v0.59.2-0.20240914165825-40d6251261f7/go.mod h1:GpWM7dewqmVYcd7SmRaiWVe9SSqjf0UrwnYnpEZNuT0=
 github.com/prometheus/exporter-toolkit v0.13.0 h1:lmA0Q+8IaXgmFRKw09RldZmZdnvu9wwcDLIXGmTPw1c=
 github.com/prometheus/exporter-toolkit v0.13.0/go.mod h1:2uop99EZl80KdXhv/MxVI2181fMcwlsumFOqBecGkG0=
 github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
@@ -168,8 +168,8 @@ google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyac
 google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
 google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
 google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc=
-google.golang.org/grpc v1.66.0 h1:DibZuoBznOxbDQxRINckZcUvnCEvrW9pcWIE2yF9r1c=
-google.golang.org/grpc v1.66.0/go.mod h1:s3/l6xSSCURdVfAnL+TqCNMyTDAGN6+lZeVxnZR128Y=
+google.golang.org/grpc v1.66.2 h1:3QdXkuq3Bkh7w+ywLdLvM56cmGvQHUMZpiCzt6Rqaoo=
+google.golang.org/grpc v1.66.2/go.mod h1:s3/l6xSSCURdVfAnL+TqCNMyTDAGN6+lZeVxnZR128Y=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
 google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=

pkg/collector/cpu/const.go

@@ -0,0 +1,28 @@
+package cpu
+
+// Processor performance counters.
+const (
+	C1TimeSeconds            = "% C1 Time"
+	C2TimeSeconds            = "% C2 Time"
+	C3TimeSeconds            = "% C3 Time"
+	C1TransitionsTotal       = "C1 Transitions/sec"
+	C2TransitionsTotal       = "C2 Transitions/sec"
+	C3TransitionsTotal       = "C3 Transitions/sec"
+	ClockInterruptsTotal     = "Clock Interrupts/sec"
+	DPCsQueuedTotal          = "DPCs Queued/sec"
+	DPCTimeSeconds           = "% DPC Time"
+	IdleBreakEventsTotal     = "Idle Break Events/sec"
+	IdleTimeSeconds          = "% Idle Time"
+	InterruptsTotal          = "Interrupts/sec"
+	InterruptTimeSeconds     = "% Interrupt Time"
+	ParkingStatus            = "Parking Status"
+	PerformanceLimitPercent  = "% Performance Limit"
+	PriorityTimeSeconds      = "% Priority Time"
+	PrivilegedTimeSeconds    = "% Privileged Time"
+	PrivilegedUtilitySeconds = "% Privileged Utility"
+	ProcessorFrequencyMHz    = "Processor Frequency"
+	ProcessorPerformance     = "% Processor Performance"
+	ProcessorTimeSeconds     = "% Processor Time"
+	ProcessorUtilityRate     = "% Processor Utility"
+	UserTimeSeconds          = "% User Time"
+)

pkg/collector/cpu/cpu.go

@@ -3,12 +3,15 @@
 package cpu
 
 import (
+	"fmt"
 	"log/slog"
 	"strings"
 
 	"github.com/alecthomas/kingpin/v2"
+	"github.com/prometheus-community/windows_exporter/pkg/perfdata"
 	"github.com/prometheus-community/windows_exporter/pkg/perflib"
 	"github.com/prometheus-community/windows_exporter/pkg/types"
+	"github.com/prometheus-community/windows_exporter/pkg/utils"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/yusufpapurcu/wmi"
 )
@@ -22,6 +25,8 @@ var ConfigDefaults = Config{}
 type Collector struct {
 	config Config
 
+	perfDataCollector *perfdata.Collector
+
 	logicalProcessors          *prometheus.Desc
 	cStateSecondsTotal         *prometheus.Desc
 	timeTotal                  *prometheus.Desc
@@ -59,6 +64,10 @@ func (c *Collector) GetName() string {
 }
 
 func (c *Collector) GetPerfCounter(_ *slog.Logger) ([]string, error) {
+	if utils.PDHEnabled() {
+		return []string{}, nil
+	}
+
 	return []string{"Processor Information"}, nil
 }
 
@@ -67,6 +76,41 @@ func (c *Collector) Close(_ *slog.Logger) error {
 }
 
 func (c *Collector) Build(_ *slog.Logger, _ *wmi.Client) error {
+	if utils.PDHEnabled() {
+		counters := []string{
+			C1TimeSeconds,
+			C2TimeSeconds,
+			C3TimeSeconds,
+			C1TransitionsTotal,
+			C2TransitionsTotal,
+			C3TransitionsTotal,
+			ClockInterruptsTotal,
+			DPCsQueuedTotal,
+			DPCTimeSeconds,
+			IdleBreakEventsTotal,
+			IdleTimeSeconds,
+			InterruptsTotal,
+			InterruptTimeSeconds,
+			ParkingStatus,
+			PerformanceLimitPercent,
+			PriorityTimeSeconds,
+			PrivilegedTimeSeconds,
+			PrivilegedUtilitySeconds,
+			ProcessorFrequencyMHz,
+			ProcessorPerformance,
+			ProcessorTimeSeconds,
+			ProcessorUtilityRate,
+			UserTimeSeconds,
+		}
+
+		var err error
+
+		c.perfDataCollector, err = perfdata.NewCollector("Processor Information", []string{"*"}, counters)
+		if err != nil {
+			return fmt.Errorf("failed to create Processor Information collector: %w", err)
+		}
+	}
+
 	c.logicalProcessors = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "logical_processor"),
 		"Total number of logical processors",
@@ -184,7 +228,11 @@ func (c *Collector) Build(_ *slog.Logger, _ *wmi.Client) error {
 func (c *Collector) Collect(ctx *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error {
 	logger = logger.With(slog.String("collector", Name))
 
-	return c.CollectFull(ctx, logger, ch)
+	if utils.PDHEnabled() {
+		return c.collectPDH(ch)
+	}
+
+	return c.collectFull(ctx, logger, ch)
 }
 
 type perflibProcessorInformation struct {
@@ -216,8 +264,7 @@ type perflibProcessorInformation struct {
 	UserTimeSeconds          float64 `perflib:"% User Time"`
 }
 
-func (c *Collector) CollectFull(ctx *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error {
-	logger = logger.With(slog.String("collector", Name))
+func (c *Collector) collectFull(ctx *types.ScrapeContext, logger *slog.Logger, ch chan<- prometheus.Metric) error {
 	data := make([]perflibProcessorInformation, 0)
 
 	err := perflib.UnmarshalObject(ctx.PerfObjects["Processor Information"], &data, logger)
@@ -364,3 +411,143 @@ func (c *Collector) CollectFull(ctx *types.ScrapeContext, logger *slog.Logger, c
 
 	return nil
 }
+
+func (c *Collector) collectPDH(ch chan<- prometheus.Metric) error {
+	data, err := c.perfDataCollector.Collect()
+	if err != nil {
+		return fmt.Errorf("failed to collect Processor Information metrics: %w", err)
+	}
+
+	var coreCount float64
+
+	for core, coreData := range data {
+		coreCount++
+
+		ch <- prometheus.MustNewConstMetric(
+			c.cStateSecondsTotal,
+			prometheus.CounterValue,
+			coreData[C1TimeSeconds].FirstValue,
+			core, "c1",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.cStateSecondsTotal,
+			prometheus.CounterValue,
+			coreData[C2TimeSeconds].FirstValue,
+			core, "c2",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.cStateSecondsTotal,
+			prometheus.CounterValue,
+			coreData[C3TimeSeconds].FirstValue,
+			core, "c3",
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.timeTotal,
+			prometheus.CounterValue,
+			coreData[IdleTimeSeconds].FirstValue,
+			core, "idle",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.timeTotal,
+			prometheus.CounterValue,
+			coreData[InterruptTimeSeconds].FirstValue,
+			core, "interrupt",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.timeTotal,
+			prometheus.CounterValue,
+			coreData[DPCTimeSeconds].FirstValue,
+			core, "dpc",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.timeTotal,
+			prometheus.CounterValue,
+			coreData[PrivilegedTimeSeconds].FirstValue,
+			core, "privileged",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.timeTotal,
+			prometheus.CounterValue,
+			coreData[UserTimeSeconds].FirstValue,
+			core, "user",
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.interruptsTotal,
+			prometheus.CounterValue,
+			coreData[InterruptsTotal].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.dpcsTotal,
+			prometheus.CounterValue,
+			coreData[DPCsQueuedTotal].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.clockInterruptsTotal,
+			prometheus.CounterValue,
+			coreData[ClockInterruptsTotal].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.idleBreakEventsTotal,
+			prometheus.CounterValue,
+			coreData[IdleBreakEventsTotal].FirstValue,
+			core,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.parkingStatus,
+			prometheus.GaugeValue,
+			coreData[ParkingStatus].FirstValue,
+			core,
+		)
+
+		ch <- prometheus.MustNewConstMetric(
+			c.processorFrequencyMHz,
+			prometheus.GaugeValue,
+			coreData[ProcessorFrequencyMHz].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.processorPerformance,
+			prometheus.CounterValue,
+			coreData[ProcessorPerformance].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.processorMPerf,
+			prometheus.CounterValue,
+			coreData[ProcessorPerformance].SecondValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.processorRTC,
+			prometheus.CounterValue,
+			coreData[ProcessorUtilityRate].SecondValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.processorUtility,
+			prometheus.CounterValue,
+			coreData[ProcessorUtilityRate].FirstValue,
+			core,
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.processorPrivilegedUtility,
+			prometheus.CounterValue,
+			coreData[PrivilegedUtilitySeconds].FirstValue,
+			core,
+		)
+	}
+
+	ch <- prometheus.MustNewConstMetric(
+		c.logicalProcessors,
+		prometheus.GaugeValue,
+		coreCount,
+	)
+
+	return nil
+}

pkg/collector/prometheus.go

@@ -228,14 +228,14 @@ func (p *Prometheus) execute(name string, c Collector, ctx *types.ScrapeContext,
 	}
 
 	if err != nil {
-		p.logger.Error(fmt.Sprintf("collector %s failed after %s", name, p.maxScrapeDuration),
+		p.logger.Error(fmt.Sprintf("collector %s failed after %s", name, duration),
 			slog.Any("err", err),
 		)
 
 		return failed
 	}
 
-	p.logger.Error(fmt.Sprintf("collector %s succeeded after %s", name, p.maxScrapeDuration))
+	p.logger.Info(fmt.Sprintf("collector %s succeeded after %s", name, duration))
 
 	return success
 }

pkg/collector/service/service.go

@@ -122,7 +122,7 @@ func (c *Collector) Build(logger *slog.Logger, _ *wmi.Client) error {
 	c.state = prometheus.NewDesc(
 		prometheus.BuildFQName(types.Namespace, Name, "state"),
 		"The state of the service (State)",
-		[]string{"name", "status"},
+		[]string{"name", "state"},
 		nil,
 	)
 	c.startMode = prometheus.NewDesc(

pkg/perfdata/collector.go

@@ -186,6 +186,7 @@ func (c *Collector) Collect() (map[string]map[string]CounterValues, error) {
 
 					// This is a workaround for the issue with the elapsed time counter type.
 					// Source: https://github.com/prometheus-community/windows_exporter/pull/335/files#diff-d5d2528f559ba2648c2866aec34b1eaa5c094dedb52bd0ff22aa5eb83226bd8dR76-R83
+					// Ref: https://learn.microsoft.com/en-us/windows/win32/perfctrs/calculating-counter-values
 
 					switch counter.Type {
 					case PERF_ELAPSED_TIME:

pkg/utils/collector.go

@@ -3,6 +3,7 @@
 package utils
 
 import (
+	"os"
 	"strings"
 
 	"github.com/prometheus-community/windows_exporter/pkg/types"
@@ -26,3 +27,11 @@ func ExpandEnabledCollectors(enabled string) []string {
 
 	return result
 }
+
+func PDHEnabled() bool {
+	if v, ok := os.LookupEnv("WINDOWS_EXPORTER_PERF_COUNTERS_ENGINE"); ok && v == "pdh" {
+		return true
+	}
+
+	return false
+}

tools/e2e-output.txt

@@ -298,13 +298,13 @@ windows_service_start_mode{name="Themes",start_mode="manual"} 0
 windows_service_start_mode{name="Themes",start_mode="system"} 0
 # HELP windows_service_state The state of the service (State)
 # TYPE windows_service_state gauge
-windows_service_state{name="Themes",status="continue pending"} 0
-windows_service_state{name="Themes",status="pause pending"} 0
-windows_service_state{name="Themes",status="paused"} 0
-windows_service_state{name="Themes",status="running"} 1
-windows_service_state{name="Themes",status="start pending"} 0
-windows_service_state{name="Themes",status="stop pending"} 0
-windows_service_state{name="Themes",status="stopped"} 0
+windows_service_state{name="Themes",state="continue pending"} 0
+windows_service_state{name="Themes",state="pause pending"} 0
+windows_service_state{name="Themes",state="paused"} 0
+windows_service_state{name="Themes",state="running"} 1
+windows_service_state{name="Themes",state="start pending"} 0
+windows_service_state{name="Themes",state="stop pending"} 0
+windows_service_state{name="Themes",state="stopped"} 0
 # HELP windows_system_context_switches_total Total number of context switches (WMI source: PerfOS_System.ContextSwitchesPersec)
 # TYPE windows_system_context_switches_total counter
 # HELP windows_system_exception_dispatches_total Total number of exceptions dispatched (WMI source: PerfOS_System.ExceptionDispatchesPersec)