Add WTS collector

Signed-off-by: Jan-Otto Kröpke <[email protected]>
prometheus-community · Jun 16, 2024 · 5a80254 · 5a80254
1 parent a4a5ac4
commit 5a80254
Show file tree

Hide file tree

Showing 8 changed files with 398 additions and 120 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ output/
 *.syso
 installer/*.msi
 installer/*.wixpdb
+local/
diff --git a/docs/collector.terminal_services.md b/docs/collector.terminal_services.md
diff --git a/pkg/collector/collector.go b/pkg/collector/collector.go
@@ -85,6 +85,8 @@ func NewWithFlags(app *kingpin.Application) Collectors {
 }
 
 // NewWithConfig To be called by the external libraries for collector initialization without running kingpin.Parse
+//
+//goland:noinspection GoUnusedExportedFunction
 func NewWithConfig(logger log.Logger, config Config) Collectors {
 	collectors := map[string]types.Collector{}
 	collectors[ad.Name] = ad.New(logger, &config.Ad)
@@ -142,6 +144,7 @@ func NewWithConfig(logger log.Logger, config Config) Collectors {
 	collectors[time.Name] = time.New(logger, &config.Time)
 	collectors[vmware.Name] = vmware.New(logger, &config.Vmware)
 	collectors[vmware_blast.Name] = vmware_blast.New(logger, &config.VmwareBlast)
+
 	return New(collectors)
 }
 

diff --git a/pkg/collector/config.go b/pkg/collector/config.go
@@ -116,6 +116,8 @@ type Config struct {
 }
 
 // ConfigDefaults Is an interface to be used by the external libraries. It holds all ConfigDefaults form all collectors
+//
+//goland:noinspection GoUnusedGlobalVariable
 var ConfigDefaults = Config{
 	Ad:                             ad.ConfigDefaults,
 	Adcs:                           adcs.ConfigDefaults,

diff --git a/pkg/collector/remote_fx/remote_fx.go b/pkg/collector/remote_fx/remote_fx.go
@@ -242,89 +242,89 @@ func (c *collector) collectRemoteFXNetworkCount(ctx *types.ScrapeContext, ch cha
 
 	for _, d := range dst {
 		// only connect metrics for remote named sessions
-		n := strings.ToLower(d.Name)
+		n := strings.ToLower(normalizeSessionName(d.Name))
 		if n == "" || n == "services" || n == "console" {
 			continue
 		}
 		ch <- prometheus.MustNewConstMetric(
 			c.BaseTCPRTT,
 			prometheus.GaugeValue,
 			utils.MilliSecToSec(d.BaseTCPRTT),
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.BaseUDPRTT,
 			prometheus.GaugeValue,
 			utils.MilliSecToSec(d.BaseUDPRTT),
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.CurrentTCPBandwidth,
 			prometheus.GaugeValue,
 			(d.CurrentTCPBandwidth*1000)/8,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.CurrentTCPRTT,
 			prometheus.GaugeValue,
 			utils.MilliSecToSec(d.CurrentTCPRTT),
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.CurrentUDPBandwidth,
 			prometheus.GaugeValue,
 			(d.CurrentUDPBandwidth*1000)/8,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.CurrentUDPRTT,
 			prometheus.GaugeValue,
 			utils.MilliSecToSec(d.CurrentUDPRTT),
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.TotalReceivedBytes,
 			prometheus.CounterValue,
 			d.TotalReceivedBytes,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.TotalSentBytes,
 			prometheus.CounterValue,
 			d.TotalSentBytes,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.UDPPacketsReceivedPersec,
 			prometheus.CounterValue,
 			d.UDPPacketsReceivedPersec,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.UDPPacketsSentPersec,
 			prometheus.CounterValue,
 			d.UDPPacketsSentPersec,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.FECRate,
 			prometheus.GaugeValue,
 			d.FECRate,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 
 		ch <- prometheus.MustNewConstMetric(
 			c.LossRate,
 			prometheus.GaugeValue,
 			d.LossRate,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 
 		ch <- prometheus.MustNewConstMetric(
 			c.RetransmissionRate,
 			prometheus.GaugeValue,
 			d.RetransmissionRate,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 	}
 	return nil
@@ -352,68 +352,73 @@ func (c *collector) collectRemoteFXGraphicsCounters(ctx *types.ScrapeContext, ch
 
 	for _, d := range dst {
 		// only connect metrics for remote named sessions
-		n := strings.ToLower(d.Name)
+		n := strings.ToLower(normalizeSessionName(d.Name))
 		if n == "" || n == "services" || n == "console" {
 			continue
 		}
 		ch <- prometheus.MustNewConstMetric(
 			c.AverageEncodingTime,
 			prometheus.GaugeValue,
 			utils.MilliSecToSec(d.AverageEncodingTime),
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.FrameQuality,
 			prometheus.GaugeValue,
 			d.FrameQuality,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.FramesSkippedPerSecondInsufficientResources,
 			prometheus.CounterValue,
 			d.FramesSkippedPerSecondInsufficientClientResources,
-			d.Name,
+			normalizeSessionName(d.Name),
 			"client",
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.FramesSkippedPerSecondInsufficientResources,
 			prometheus.CounterValue,
 			d.FramesSkippedPerSecondInsufficientNetworkResources,
-			d.Name,
+			normalizeSessionName(d.Name),
 			"network",
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.FramesSkippedPerSecondInsufficientResources,
 			prometheus.CounterValue,
 			d.FramesSkippedPerSecondInsufficientServerResources,
-			d.Name,
+			normalizeSessionName(d.Name),
 			"server",
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.GraphicsCompressionratio,
 			prometheus.GaugeValue,
 			d.GraphicsCompressionratio,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.InputFramesPerSecond,
 			prometheus.CounterValue,
 			d.InputFramesPerSecond,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.OutputFramesPerSecond,
 			prometheus.CounterValue,
 			d.OutputFramesPerSecond,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 		ch <- prometheus.MustNewConstMetric(
 			c.SourceFramesPerSecond,
 			prometheus.CounterValue,
 			d.SourceFramesPerSecond,
-			d.Name,
+			normalizeSessionName(d.Name),
 		)
 	}
 
 	return nil
 }
+
+// normalizeSessionName ensure that the session is the same between WTS API and performance counters
+func normalizeSessionName(sessionName string) string {
+	return strings.Replace(sessionName, "RDP-tcp", "RDP-Tcp", 1)
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,3 +8,4 @@ output/ @@
     *.syso
     installer/*.msi
     installer/*.wixpdb
+    local/