performancecounter: Add the possibility to request formatted values (#1830)

2026-02-23 13:16:36 +00:00 · 2025-01-14 23:32:44 +01:00
parent 4cd9627ebf
commit 86e6d12518
80 changed files with 354 additions and 132 deletions
--- a/internal/collector/performancecounter/performancecounter.go
+++ b/internal/collector/performancecounter/performancecounter.go
@@ -35,7 +35,16 @@ import (

 const Name = "performancecounter"

-var reNonAlphaNum = regexp.MustCompile(`[^a-zA-Z0-9]`)
+var (
+	reNonAlphaNum = regexp.MustCompile(`[^a-zA-Z0-9]`)
+
+	//nolint:gochecknoglobals // strings.NewReplacer is safe for concurrent use
+	stringReplacer = strings.NewReplacer(
+		"%", "percent",
+		"(", "",
+		")", "",
+	)
+)

 type Config struct {
 	Objects []Object `yaml:"objects"`
@@ -200,7 +209,11 @@ func (c *Collector) Build(logger *slog.Logger, _ *mi.Session) error {

 		valueType := reflect.StructOf(fields)

-		collector, err := pdh.NewCollectorWithReflection(object.Object, object.Instances, valueType)
+		if object.Type == "" {
+			object.Type = pdh.CounterTypeRaw
+		}
+
+		collector, err := pdh.NewCollectorWithReflection(object.Type, object.Object, object.Instances, valueType)
 		if err != nil {
 			errs = append(errs, fmt.Errorf("failed collector for %s: %w", object.Name, err))
 		}
@@ -364,5 +377,5 @@ func (c *Collector) collectObject(ch chan<- prometheus.Metric, perfDataObject Ob
 }

 func sanitizeMetricName(name string) string {
-	return strings.Trim(reNonAlphaNum.ReplaceAllString(strings.ToLower(name), "_"), "_")
+	return strings.Trim(reNonAlphaNum.ReplaceAllString(strings.ToLower(stringReplacer.Replace(name)), "_"), "_")
 }
--- a/internal/collector/performancecounter/performancecounter_test_test.go
+++ b/internal/collector/performancecounter/performancecounter_test_test.go
@@ -52,6 +52,7 @@ func TestCollector(t *testing.T) {
 	for _, tc := range []struct {
 		name            string
 		object          string
+		counterType     pdh.CounterType
 		instances       []string
 		instanceLabel   string
 		buildErr        string
@@ -59,11 +60,12 @@ func TestCollector(t *testing.T) {
 		expectedMetrics *regexp.Regexp
 	}{
 		{
-			name:      "memory",
-			object:    "Memory",
-			instances: nil,
-			buildErr:  "",
-			counters:  []performancecounter.Counter{{Name: "Available Bytes", Type: "gauge"}},
+			name:        "memory",
+			object:      "Memory",
+			counterType: pdh.CounterTypeRaw,
+			instances:   nil,
+			buildErr:    "",
+			counters:    []performancecounter.Counter{{Name: "Available Bytes", Type: "gauge"}},
 			expectedMetrics: regexp.MustCompile(`^# HELP windows_performancecounter_collector_duration_seconds windows_exporter: Duration of an performancecounter child collection.
 # TYPE windows_performancecounter_collector_duration_seconds gauge
 windows_performancecounter_collector_duration_seconds\{collector="memory"} [0-9.e+-]+
@@ -75,11 +77,12 @@ windows_performancecounter_collector_success\{collector="memory"} 1
 windows_performancecounter_memory_available_bytes [0-9.e+-]+`),
 		},
 		{
-			name:      "process",
-			object:    "Process",
-			instances: []string{"*"},
-			buildErr:  "",
-			counters:  []performancecounter.Counter{{Name: "Thread Count", Type: "counter"}},
+			name:        "process",
+			object:      "Process",
+			counterType: "",
+			instances:   []string{"*"},
+			buildErr:    "",
+			counters:    []performancecounter.Counter{{Name: "Thread Count", Type: "counter"}},
 			expectedMetrics: regexp.MustCompile(`^# HELP windows_performancecounter_collector_duration_seconds windows_exporter: Duration of an performancecounter child collection.
 # TYPE windows_performancecounter_collector_duration_seconds gauge
 windows_performancecounter_collector_duration_seconds\{collector="process"} [0-9.e+-]+
@@ -94,6 +97,7 @@ windows_performancecounter_process_thread_count\{instance=".+"} [0-9.e+-]+
 		{
 			name:          "processor_information",
 			object:        "Processor Information",
+			counterType:   pdh.CounterTypeRaw,
 			instances:     []string{"*"},
 			instanceLabel: "core",
 			buildErr:      "",
@@ -108,11 +112,32 @@ windows_performancecounter_collector_success\{collector="processor_information"}
 # TYPE windows_performancecounter_processor_information_processor_time counter
 windows_performancecounter_processor_information_processor_time\{core="0,0",state="active"} [0-9.e+-]+
 windows_performancecounter_processor_information_processor_time\{core="0,0",state="idle"} [0-9.e+-]+
+.*`),
+		},
+		{
+			name:          "processor_information_formatted",
+			object:        "Processor Information",
+			counterType:   pdh.CounterTypeFormatted,
+			instances:     []string{"*"},
+			instanceLabel: "core",
+			buildErr:      "",
+			counters:      []performancecounter.Counter{{Name: "% Processor Time", Metric: "windows_performancecounter_processor_information_processor_time", Labels: map[string]string{"state": "active"}}, {Name: "% Idle Time", Metric: "windows_performancecounter_processor_information_processor_time", Labels: map[string]string{"state": "idle"}}},
+			expectedMetrics: regexp.MustCompile(`^# HELP windows_performancecounter_collector_duration_seconds windows_exporter: Duration of an performancecounter child collection.
+# TYPE windows_performancecounter_collector_duration_seconds gauge
+windows_performancecounter_collector_duration_seconds\{collector="processor_information_formatted"} [0-9.e+-]+
+# HELP windows_performancecounter_collector_success windows_exporter: Whether a performancecounter child collector was successful.
+# TYPE windows_performancecounter_collector_success gauge
+windows_performancecounter_collector_success\{collector="processor_information_formatted"} 1
+# HELP windows_performancecounter_processor_information_processor_time windows_exporter: custom Performance Counter metric
+# TYPE windows_performancecounter_processor_information_processor_time gauge
+windows_performancecounter_processor_information_processor_time\{core="0,0",state="active"} [0-9]+
+windows_performancecounter_processor_information_processor_time\{core="0,0",state="idle"} [0-9]+
 .*`),
 		},
 		{
 			name:            "",
 			object:          "Processor Information",
+			counterType:     pdh.CounterTypeRaw,
 			instances:       nil,
 			instanceLabel:   "",
 			buildErr:        "object name is required",
@@ -122,6 +147,7 @@ windows_performancecounter_processor_information_processor_time\{core="0,0",stat
 		{
 			name:            "double_counter",
 			object:          "Memory",
+			counterType:     pdh.CounterTypeRaw,
 			instances:       nil,
 			buildErr:        "counter name Available Bytes is duplicated",
 			counters:        []performancecounter.Counter{{Name: "Available Bytes", Type: "gauge"}, {Name: "Available Bytes", Type: "gauge"}},
@@ -130,11 +156,21 @@ windows_performancecounter_processor_information_processor_time\{core="0,0",stat
 		{
 			name:            "counter with spaces and brackets",
 			object:          "invalid",
+			counterType:     pdh.CounterTypeRaw,
 			instances:       nil,
 			buildErr:        pdh.NewPdhError(pdh.CstatusNoObject).Error(),
 			counters:        []performancecounter.Counter{{Name: "Total Memory Usage --- Non-Paged Pool", Type: "counter"}, {Name: "Max Session Input Delay (ms)", Type: "counter"}},
 			expectedMetrics: nil,
 		},
+		{
+			name:            "invalid counter type",
+			object:          "invalid",
+			counterType:     "invalid",
+			instances:       nil,
+			buildErr:        "invalid result type: ",
+			counters:        []performancecounter.Counter{{Name: "Total Memory Usage --- Non-Paged Pool", Type: "counter"}, {Name: "Max Session Input Delay (ms)", Type: "counter"}},
+			expectedMetrics: nil,
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
@@ -144,6 +180,7 @@ windows_performancecounter_processor_information_processor_time\{core="0,0",stat
 					{
 						Name:          tc.name,
 						Object:        tc.object,
+						Type:          tc.counterType,
 						Instances:     tc.instances,
 						InstanceLabel: tc.instanceLabel,
 						Counters:      tc.counters,
--- a/internal/collector/performancecounter/types.go
+++ b/internal/collector/performancecounter/types.go
@@ -20,11 +20,12 @@ import (
 )

 type Object struct {
-	Name          string    `json:"name"           yaml:"name"`
-	Object        string    `json:"object"         yaml:"object"`
-	Instances     []string  `json:"instances"      yaml:"instances"`
-	Counters      []Counter `json:"counters"       yaml:"counters"`
-	InstanceLabel string    `json:"instance_label" yaml:"instance_label"` //nolint:tagliatelle
+	Name          string          `json:"name"           yaml:"name"`
+	Object        string          `json:"object"         yaml:"object"`
+	Type          pdh.CounterType `json:"type"           yaml:"type"`
+	Instances     []string        `json:"instances"      yaml:"instances"`
+	Counters      []Counter       `json:"counters"       yaml:"counters"`
+	InstanceLabel string          `json:"instance_label" yaml:"instance_label"` //nolint:tagliatelle

 	collector      *pdh.Collector
 	perfDataObject any