Merge pull request #171 from PureStorage-OpenConnect/170-consider-backporting-new-metrics---qos-metrics

sdodsley · web-flow · commit a54adaa4b841 · 2025-01-24T18:28:00.000-05:00
Add QoS Metrics
diff --git a/internal/openmetrics-exporter/collector.go b/internal/openmetrics-exporter/collector.go
@@ -73,7 +73,7 @@ func Collector(ctx context.Context, metrics string, registry *prometheus.Registr
 	if metrics == "all" || metrics == "volumes" {
 		vols := faclient.GetVolumes()
 		volperfcoll := NewVolumesPerformanceCollector(faclient, vols)
-		volspacecoll := NewVolumesSpaceCollector(vols)
+		volspacecoll := NewVolumesCollector(vols)
 		registry.MustRegister(
 			volperfcoll,
 			volspacecoll,
diff --git a/internal/openmetrics-exporter/volumes_collector.go b/internal/openmetrics-exporter/volumes_collector.go
@@ -6,23 +6,41 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 )
 
-type VolumesSpaceCollector struct {
-	ReductionDesc *prometheus.Desc
-	SpaceDesc     *prometheus.Desc
-	Volumes       *client.VolumesList
+type VolumesCollector struct {
+	QoSBandwidthLimitDesc *prometheus.Desc
+	QoSIPOSLimitDesc      *prometheus.Desc
+	ReductionDesc         *prometheus.Desc
+	SpaceDesc             *prometheus.Desc
+	Volumes               *client.VolumesList
 }
 
-func (c *VolumesSpaceCollector) Describe(ch chan<- *prometheus.Desc) {
+func (c *VolumesCollector) Describe(ch chan<- *prometheus.Desc) {
 	prometheus.DescribeByCollect(c, ch)
 }
 
-func (c *VolumesSpaceCollector) Collect(ch chan<- prometheus.Metric) {
+func (c *VolumesCollector) Collect(ch chan<- prometheus.Metric) {
 	purenaa := "naa.624a9370"
 	volumes := c.Volumes
 	if len(volumes.Items) == 0 {
 		return
 	}
 	for _, v := range volumes.Items {
+		if v.QoS.BandwidthLimit != nil {
+			ch <- prometheus.MustNewConstMetric(
+				c.QoSBandwidthLimitDesc,
+				prometheus.GaugeValue,
+				float64(*v.QoS.BandwidthLimit),
+				purenaa+v.Serial, v.Name, v.Pod.Name, v.VolumeGroup.Name,
+			)
+		}
+		if v.QoS.IopsLimit != nil {
+			ch <- prometheus.MustNewConstMetric(
+				c.QoSIPOSLimitDesc,
+				prometheus.GaugeValue,
+				float64(*v.QoS.IopsLimit),
+				purenaa+v.Serial, v.Name, v.Pod.Name, v.VolumeGroup.Name,
+			)
+		}
 		if v.Space.DataReduction != nil {
 			ch <- prometheus.MustNewConstMetric(
 				c.ReductionDesc,
@@ -146,8 +164,20 @@ func (c *VolumesSpaceCollector) Collect(ch chan<- prometheus.Metric) {
 	}
 }
 
-func NewVolumesSpaceCollector(volumes *client.VolumesList) *VolumesSpaceCollector {
-	return &VolumesSpaceCollector{
+func NewVolumesCollector(volumes *client.VolumesList) *VolumesCollector {
+	return &VolumesCollector{
+		QoSBandwidthLimitDesc: prometheus.NewDesc(
+			"purefa_volume_qos_bandwidth_bytes_per_sec_limit",
+			"FlashArray volume maximum QoS bandwidth limit in bytes per second",
+			[]string{"naa_id", "name", "pod", "volume_group"},
+			prometheus.Labels{},
+		),
+		QoSIPOSLimitDesc: prometheus.NewDesc(
+			"purefa_volume_qos_iops_limit",
+			"FlashArray volume QoS IOPs limit",
+			[]string{"naa_id", "name", "pod", "volume_group"},
+			prometheus.Labels{},
+		),
 		ReductionDesc: prometheus.NewDesc(
 			"purefa_volume_space_data_reduction_ratio",
 			"FlashArray volume space data reduction",
diff --git a/internal/openmetrics-exporter/volumes_collector_test.go b/internal/openmetrics-exporter/volumes_collector_test.go
@@ -35,6 +35,12 @@ func TestVolumesSpaceCollector(t *testing.T) {
 	e := endp[len(endp)-1]
 	want := make(map[string]bool)
 	for _, v := range volumes.Items {
+		if v.QoS.BandwidthLimit != nil {
+			want[fmt.Sprintf("label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} label:{name:\"pod\" value:\"%s\"} label:{name:\"volume_group\" value:\"%s\"} gauge:{value:%g}", purenaa+v.Serial, v.Name, v.Pod.Name, v.VolumeGroup.Name, float64(*v.QoS.BandwidthLimit))] = true
+		}
+		if v.QoS.IopsLimit != nil {
+			want[fmt.Sprintf("label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} label:{name:\"pod\" value:\"%s\"} label:{name:\"volume_group\" value:\"%s\"} gauge:{value:%g}", purenaa+v.Serial, v.Name, v.Pod.Name, v.VolumeGroup.Name, float64(*v.QoS.IopsLimit))] = true
+		}
 		if v.Space.DataReduction != nil {
 			want[fmt.Sprintf("label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} label:{name:\"pod\" value:\"%s\"} label:{name:\"volume_group\" value:\"%s\"} gauge:{value:%g}", purenaa+v.Serial, v.Name, v.Pod.Name, v.VolumeGroup.Name, *v.Space.DataReduction)] = true
 		}
@@ -84,6 +90,6 @@ func TestVolumesSpaceCollector(t *testing.T) {
 	defer server.Close()
 	c := client.NewRestClient(e, "fake-api-token", "latest", "test-user-agent-string", "test-X-Request-Id-string", false, false)
 	vl := c.GetVolumes()
-	pc := NewVolumesSpaceCollector(vl)
+	pc := NewVolumesCollector(vl)
 	metricsCheck(t, pc, want)
 }
diff --git a/internal/openmetrics-exporter/volumes_performance_collector.go b/internal/openmetrics-exporter/volumes_performance_collector.go
@@ -1,9 +1,9 @@
 package collectors
 
-
 import (
+	client "purestorage/fa-openmetrics-exporter/internal/rest-client"
+
 	"github.com/prometheus/client_golang/prometheus"
-	"purestorage/fa-openmetrics-exporter/internal/rest-client"
 )
 
 type VolumesPerformanceCollector struct {
@@ -103,6 +103,24 @@ func (c *VolumesPerformanceCollector) Collect(ch chan<- prometheus.Metric) {
 			vp.ServiceUsecPerReadOpCacheReduction,
 			c.NAAids[vp.Name], vp.Name, "service_usec_per_read_op_cache_reduction",
 		)
+		ch <- prometheus.MustNewConstMetric(
+			c.LatencyDesc,
+			prometheus.GaugeValue,
+			float64(*vp.QosRateLimitUsecPerMirroredWriteOp),
+			c.NAAids[vp.Name], vp.Name, "qos_rate_limit_usec_per_mirrored_write_op",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.LatencyDesc,
+			prometheus.GaugeValue,
+			float64(*vp.QosRateLimitUsecPerReadOp),
+			c.NAAids[vp.Name], vp.Name, "qos_rate_limit_usec_per_read_op",
+		)
+		ch <- prometheus.MustNewConstMetric(
+			c.LatencyDesc,
+			prometheus.GaugeValue,
+			float64(*vp.QosRateLimitUsecPerWriteOp),
+			c.NAAids[vp.Name], vp.Name, "qos_rate_limit_usec_per_write_op",
+		)
 		ch <- prometheus.MustNewConstMetric(
 			c.BandwidthDesc,
 			prometheus.GaugeValue,
diff --git a/internal/openmetrics-exporter/volumes_performance_collector_test.go b/internal/openmetrics-exporter/volumes_performance_collector_test.go
@@ -50,6 +50,9 @@ func TestVolumesPerformanceCollector(t *testing.T) {
 	}
 	want := make(map[string]bool)
 	for _, p := range volumesperf.Items {
+		want[fmt.Sprintf("label:{name:\"dimension\" value:\"qos_rate_limit_usec_per_mirrored_write_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, float64(*p.QosRateLimitUsecPerMirroredWriteOp))] = true
+		want[fmt.Sprintf("label:{name:\"dimension\" value:\"qos_rate_limit_usec_per_read_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, float64(*p.QosRateLimitUsecPerReadOp))] = true
+		want[fmt.Sprintf("label:{name:\"dimension\" value:\"qos_rate_limit_usec_per_write_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, float64(*p.QosRateLimitUsecPerWriteOp))] = true
 		want[fmt.Sprintf("label:{name:\"dimension\" value:\"queue_usec_per_mirrored_write_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, p.QueueUsecPerMirroredWriteOp)] = true
 		want[fmt.Sprintf("label:{name:\"dimension\" value:\"queue_usec_per_read_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, p.QueueUsecPerReadOp)] = true
 		want[fmt.Sprintf("label:{name:\"dimension\" value:\"queue_usec_per_write_op\"} label:{name:\"naa_id\" value:\"%s\"} label:{name:\"name\" value:\"%s\"} gauge:{value:%g}", naaid[p.Name], p.Name, p.QueueUsecPerWriteOp)] = true
diff --git a/internal/rest-client/volumes.go b/internal/rest-client/volumes.go
@@ -1,8 +1,8 @@
 package client
 
 type Qos struct {
-	BandwidthLimit int `json:"bandwidth_limit"`
-	IopsLimit      int `json:"iops_limit"`
+	BandwidthLimit *int64 `json:"bandwidth_limit"`
+	IopsLimit      *int64 `json:"iops_limit"`
 }
 
 type PriorityAdjustment struct {
@@ -29,6 +29,7 @@ type Volume struct {
 	HostEncryptionKeyStatus string             `json:"host_encryption_key_status"`
 	PriorityAdjustment      PriorityAdjustment `json:"priority_adjustment"`
 	Provisioned             int                `json:"provisioned"`
+	QoS                     Qos                `json:"qos"`
 	Serial                  string             `json:"serial"`
 	Space                   Space              `json:"space"`
 	TimeRemaining           int                `json:"time_remaining"`
diff --git a/internal/rest-client/volumes_performance.go b/internal/rest-client/volumes_performance.go
@@ -9,9 +9,9 @@ type VolumePerformance struct {
 	BytesPerWrite                      float64 `json:"bytes_per_write"`
 	MirroredWriteBytesPerSec           float64 `json:"mirrored_write_bytes_per_sec"`
 	MirroredWritesPerSec               float64 `json:"mirrored_writes_per_sec"`
-	QosRateLimitUsecPerMirroredWriteOp float64 `json:"qos_rate_limit_usec_per_mirrored_write_op"`
-	QosRateLimitUsecPerReadOp          float64 `json:"qos_rate_limit_usec_per_read_op"`
-	QosRateLimitUsecPerWriteOp         float64 `json:"qos_rate_limit_usec_per_write_op"`
+	QosRateLimitUsecPerMirroredWriteOp *int64  `json:"qos_rate_limit_usec_per_mirrored_write_op"`
+	QosRateLimitUsecPerReadOp          *int64  `json:"qos_rate_limit_usec_per_read_op"`
+	QosRateLimitUsecPerWriteOp         *int64  `json:"qos_rate_limit_usec_per_write_op"`
 	QueueUsecPerMirroredWriteOp        float64 `json:"queue_usec_per_mirrored_write_op"`
 	QueueUsecPerReadOp                 float64 `json:"queue_usec_per_read_op"`
 	QueueUsecPerWriteOp                float64 `json:"queue_usec_per_write_op"`
diff --git a/specification/metrics/purefa-metrics.md b/specification/metrics/purefa-metrics.md
