chore(deps): Upgrade windows exporter to v0.29.2 (#215)

Author: abhishuraina

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.1.0 (2024-12-17)
+### Changed
+- Upgraded the exporter version to v0.29.2
+
 ## 1.0.3 (2024-09-10)
 ### Fixed
 - Bumped dependencies

src/exporter/exporter.go

@@ -58,10 +58,11 @@ func New(verbose bool, bindAddress string, bindPort string) (*Exporter, error) {
 		exporterPath,
 		"--collectors.enabled", enabledCollectors,
 		"--log.level", exporterLogLevel,
-		"--log.format", "logger:stderr?json=true",
-		"--collector.service.use-api",                         // enable collection using windows API instead of WMI
-		"--collector.service.services-where", "Name like '%'", // All Added to avoid warn message from Exporter
-		"--telemetry.addr", exporterURL)
+		"--log.format", "json",
+		// "--collector.service.use-api", // The WMI based collector is gone used to enable collection using windows API instead of WMI
+		"--collector.service.include", ".*", // All Added to avoid warn message from Exporter
+		"--web.listen-address", exporterURL,
+	)
 
 	return &Exporter{
 		URL:        exporterURL,

src/nri/metricsProcesor.go

@@ -7,6 +7,7 @@ package nri
 
 import (
 	"fmt"
+	"strings"
 	"time"
 
 	"github.com/newrelic/nri-winservices/src/matcher"
@@ -43,14 +44,28 @@ func ProcessMetrics(i *integration.Integration, metricFamilyMap scraper.MetricFa
 
 	for _, metricsRules := range entityRules.Metrics {
 		if metricFamily, ok := metricFamilyMap[metricsRules.ProviderName]; ok {
-			if err := processMetricGauge(metricFamily, entityRules, entityMap, hostname); err != nil {
+			if err := processMetricGauge(metricFamily, entityRules, entityMap, metricFamilyMap, hostname); err != nil {
 				log.Warn("error processing metric:%v", err.Error())
 			}
 		}
 	}
 	return nil
 }
 
+func findProcessId(metricFamily dto.MetricFamily, key string, entityRules EntityRules) (string, error) {
+	for _, m := range metricFamily.GetMetric() {
+		serviceName, _ := getLabelValue(m.GetLabel(), entityRules.EntityName.Label)
+		if serviceName == key {
+			for _, l := range m.GetLabel() {
+				if l.GetName() == "process_id" {
+					return l.GetValue(), nil
+				}
+			}
+		}
+	}
+	return "", fmt.Errorf("label %v not found", key)
+}
+
 func createEntities(integrationInstance *integration.Integration, metricFamilyMap scraper.MetricFamiliesByName, entityRules EntityRules, matcher matcher.Matcher) (entitiesByName, error) {
 	entityMap := make(map[string]*integration.Entity)
 
@@ -80,7 +95,7 @@ func createEntities(integrationInstance *integration.Integration, metricFamilyMa
 			continue
 		}
 
-		entityName := fmt.Sprintf("%s:%s:%s", entityNamePrefix, hostName, serviceName)
+		entityName := fmt.Sprintf("%s:%s:%s", entityNamePrefix, hostName, strings.ToLower(serviceName))
 
 		entity, err := integrationInstance.NewEntity(entityName, entityRules.EntityType, serviceDisplayName)
 		if err != nil {
@@ -95,7 +110,7 @@ func createEntities(integrationInstance *integration.Integration, metricFamilyMa
 	return entityMap, nil
 }
 
-func processMetricGauge(metricFamily dto.MetricFamily, entityRules EntityRules, ebn entitiesByName, hostname string) error {
+func processMetricGauge(metricFamily dto.MetricFamily, entityRules EntityRules, ebn entitiesByName, metricFamilyMap scraper.MetricFamiliesByName, hostname string) error {
 	metricRules, err := entityRules.getMetricRules(metricFamily.GetName())
 	if err != nil {
 		return fmt.Errorf("metric rule not found")
@@ -121,6 +136,19 @@ func processMetricGauge(metricFamily dto.MetricFamily, entityRules EntityRules,
 		}
 
 		attributes, metadata := getAttributesAndMetadata(entityRules, metricRules.Attributes, m, hostname)
+		// Add process_id to windows_service_info metrics Family
+		if metricFamily.GetName() == "windows_service_info" {
+			winServiceProcess, ok := metricFamilyMap["windows_service_process"]
+			if ok {
+				processId, err := findProcessId(winServiceProcess, serviceName, entityRules)
+				if err != nil {
+					metadata["process_id"] = "0"
+				} else {
+					metadata["process_id"] = processId
+
+				}
+			}
+		}
 		addMetadata(metadata, e)
 		// _info metrics only contains metadata
 		if metricRules.InfoMetric {
@@ -143,6 +171,11 @@ func processMetricGauge(metricFamily dto.MetricFamily, entityRules EntityRules,
 func addMetadata(metadata metadataMap, e *integration.Entity) {
 	var err error
 	for k, v := range metadata {
+		// latest version exporter sends service_name in camel case
+		// for consistency we need to convert it to lowercase
+		if k == "service_name" {
+			v = strings.ToLower(v)
+		}
 		err = e.AddMetadata(k, v)
 		warnOnErr(err)
 	}

src/nri/metricsProcesor_test.go

@@ -6,6 +6,7 @@
 package nri
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/newrelic/infra-integrations-sdk/v4/integration"
@@ -17,7 +18,7 @@ import (
 )
 
 const (
-	serviceName        = "rpcss"
+	serviceName        = "RpcSs"
 	serviceStartMode   = "auto"
 	serviceDisplayName = "Remote Procedure Call (RPC)"
 	servicePid         = "668"
@@ -89,6 +90,28 @@ var metricFamlilyService = dto.MetricFamily{
 	},
 }
 
+var metricFamlilyServiceProcess = dto.MetricFamily{
+	Name: strPtr("windows_service_process"),
+	Type: &gauge,
+	Metric: []*dto.Metric{
+		{
+			Label: []*dto.LabelPair{
+				{
+					Name:  strPtr("name"),
+					Value: strPtr(serviceName),
+				},
+				{
+					Name:  strPtr("process_id"),
+					Value: strPtr(servicePid),
+				},
+			},
+			Gauge: &dto.Gauge{
+				Value: float64Ptr(1),
+			},
+		},
+	},
+}
+
 func TestCreateEntities(t *testing.T) {
 	i, _ := integration.New("integrationName", "integrationVersion")
 	rules := loadRules()
@@ -103,7 +126,7 @@ func TestCreateEntities(t *testing.T) {
 	_, ok := entityMap[serviceName]
 	require.True(t, ok)
 	require.Len(t, i.Entities, 1)
-	require.Equal(t, i.Entities[0].Name(), entityNamePrefix+":"+hostName+":"+serviceName)
+	require.Equal(t, i.Entities[0].Name(), entityNamePrefix+":"+hostName+":"+strings.ToLower(serviceName))
 	require.False(t, i.Entities[0].IgnoreEntity)
 }
 
@@ -119,8 +142,8 @@ func TestNoServiceNameAllowed(t *testing.T) {
 	entityMap, err := createEntities(i, mfbn, rules, matcher)
 	require.NoError(t, err, "No error is expected even if no service is allowed")
 	require.Len(t, entityMap, 0, "No entity is expected since no service is allowed")
-	err = processMetricGauge(metricFamlilyService, rules, entityMap, hostname)
-	err = processMetricGauge(metricFamlilyService, rules, entityMap, hostname)
+	err = processMetricGauge(metricFamlilyService, rules, entityMap, mfbn, hostname)
+	err = processMetricGauge(metricFamlilyService, rules, entityMap, mfbn, hostname)
 	require.NoError(t, err)
 	require.NoError(t, err, "No error is expected even if entityMap is empty")
 }
@@ -131,22 +154,31 @@ func TestProccessMetricGauge(t *testing.T) {
 	mfbn := scraper.MetricFamiliesByName{
 		"windows_service_info":       metricFamlilyServiceInfo,
 		"windows_service_start_mode": metricFamlilyService,
+		"windows_service_process":    metricFamlilyServiceProcess,
 	}
 
 	matcher := matcher.New(filter)
 	entityMap, err := createEntities(i, mfbn, rules, matcher)
 	require.NoError(t, err)
 	// process info metrics
-	err = processMetricGauge(metricFamlilyServiceInfo, rules, entityMap, hostname)
+	err = processMetricGauge(metricFamlilyServiceInfo, rules, entityMap, mfbn, hostname)
 	require.NoError(t, err)
 	metadata := entityMap[serviceName].GetMetadata()
 	assert.Equal(t, serviceDisplayName, metadata["display_name"])
-	assert.Equal(t, servicePid, metadata["process_id"])
+
+	// Service name in lowercase check
+	assert.Equal(t, strings.ToLower(serviceName), metadata["service_name"])
+
 	// process startmode metrics
-	err = processMetricGauge(metricFamlilyService, rules, entityMap, hostname)
+	err = processMetricGauge(metricFamlilyService, rules, entityMap, mfbn, hostname)
 	assert.NoError(t, err)
 	assert.Equal(t, serviceStartMode, metadata["start_mode"])
 
+	// process start process metrics
+	err = processMetricGauge(metricFamlilyServiceProcess, rules, entityMap, mfbn, hostname)
+	assert.NoError(t, err)
+	assert.Equal(t, servicePid, metadata["process_id"])
+
 }
 
 func strPtr(s string) *string {

src/nri/rules.go

@@ -83,11 +83,6 @@ func loadRules() EntityRules {
 						NrdbLabelName:    "display_name",
 						IsEntityMetadata: true,
 					},
-					{
-						Label:            "process_id",
-						NrdbLabelName:    "process_id",
-						IsEntityMetadata: true,
-					},
 				},
 			},
 			{
@@ -115,6 +110,24 @@ func loadRules() EntityRules {
 					},
 				},
 			},
+			{
+				ProviderName: "windows_service_process",
+				MetricType:   "gauge",
+				NrdbName:     "windows_service_process",
+				EnumMetric:   true,
+				Attributes: []Attribute{
+					{
+						Label:            "name",
+						NrdbLabelName:    "service_name",
+						IsEntityMetadata: true,
+					},
+					{
+						Label:            "process_id",
+						NrdbLabelName:    "process_id",
+						IsEntityMetadata: true,
+					},
+				},
+			},
 		},
 	}
 

win_build.ps1

@@ -21,10 +21,9 @@ $commitHash = (git rev-parse HEAD)
 
 $exporterRepo = "github.com/prometheus-community/windows_exporter"
 $exporterBinaryName = "windows_exporter.exe"
-# Commit used by v0.16.0 of windows_exporter
-$exporterVersion = "1c199e6c0eed881fb09dfcc84eee191262215e5e"
-# Collector used by the Windows Service integration
-$collectors = "collector.go","wmi.go","perflib.go","service.go","cs.go"
+# Commit used by v0.29.2 of windows_exporter
+$exporterVersion = "622813343f930c121c8b1c061d6dd6f02d96015f"
+
 
 $env:GOPATH = go env GOPATH
 $env:GOBIN = "$env:GOPATH\bin"
@@ -111,8 +110,6 @@ if (-Not $skipExporterCompile)
         exit -1
     }
 
-    # remove unused collectors 
-    Remove-Item .\collector\* -Exclude $collectors
     $ErrorActionPreference = "SilentlyContinue"
     go mod download
     $ErrorActionPreference = "Stop"