feat: add workload panels in workload dashboard

cmd/collectors/restperf/restperf.go

@@ -19,6 +19,7 @@ import (
 	"github.com/netapp/harvest/v2/pkg/errs"
 	"github.com/netapp/harvest/v2/pkg/matrix"
 	"github.com/netapp/harvest/v2/pkg/set"
+	"github.com/netapp/harvest/v2/pkg/tree/node"
 	"github.com/netapp/harvest/v2/pkg/util"
 	"github.com/tidwall/gjson"
 	"path"
@@ -28,9 +29,11 @@ import (
 )
 
 const (
-	latencyIoReqd = 10
-	BILLION       = 1_000_000_000
-	arrayKeyToken = "#"
+	latencyIoReqd          = 10
+	BILLION                = 1_000_000_000
+	arrayKeyToken          = "#"
+	objWorkloadClass       = "user_defined|system_defined"
+	objWorkloadVolumeClass = "autovolume"
 )
 
 var qosQuery = "api/cluster/counter/tables/qos"
@@ -171,6 +174,27 @@ func (r *RestPerf) InitMatrix() error {
 	return nil
 }
 
+// load workload_class or use defaultValue
+func (r *RestPerf) loadWorkloadClassQuery(defaultValue string) string {
+
+	var x *node.Node
+
+	name := "workload_class"
+
+	if x = r.Params.GetChildS(name); x != nil {
+		v := x.GetAllChildContentS()
+		if len(v) == 0 {
+			r.Logger.Debug().Msgf("using %s = [%s] (default)", name, defaultValue)
+			return defaultValue
+		}
+		s := strings.Join(v, "|")
+		r.Logger.Debug().Msgf("using %s = [%s]", name, s)
+		return s
+	}
+	r.Logger.Debug().Msgf("using %s = [%s] (default)", name, defaultValue)
+	return defaultValue
+}
+
 // load an int parameter or use defaultValue
 func (r *RestPerf) loadParamInt(name string, defaultValue int) int {
 
@@ -1255,9 +1279,9 @@ func (r *RestPerf) PollInstance() (map[string]*matrix.Matrix, error) {
 		fields = "*"
 		dataQuery = qosWorkloadQuery
 		if r.Prop.Query == qosVolumeQuery || r.Prop.Query == qosDetailVolumeQuery {
-			filter = append(filter, "workload-class=autovolume|user_defined|system_defined")
+			filter = append(filter, "workload_class="+r.loadWorkloadClassQuery(objWorkloadVolumeClass))
 		} else {
-			filter = append(filter, "workload-class=user_defined|system_defined")
+			filter = append(filter, "workload_class="+r.loadWorkloadClassQuery(objWorkloadClass))
 		}
 	}
 

cmd/collectors/zapiperf/zapiperf.go

@@ -60,6 +60,8 @@ const (
 	objWorkloadDetail       = "workload_detail"
 	objWorkloadVolume       = "workload_volume"
 	objWorkloadDetailVolume = "workload_detail_volume"
+	objWorkloadClass        = "user_defined|system_defined"
+	objWorkloadVolumeClass  = "autovolume"
 	BILLION                 = 1_000_000_000
 )
 
@@ -172,6 +174,27 @@ func (z *ZapiPerf) loadParamStr(name, defaultValue string) string {
 	return defaultValue
 }
 
+// load workload_class or use defaultValue
+func (z *ZapiPerf) loadWorkloadClassQuery(defaultValue string) string {
+
+	var x *node.Node
+
+	name := "workload_class"
+
+	if x = z.Params.GetChildS(name); x != nil {
+		v := x.GetAllChildContentS()
+		if len(v) == 0 {
+			z.Logger.Debug().Msgf("using %s = [%s] (default)", name, defaultValue)
+			return defaultValue
+		}
+		s := strings.Join(v, "|")
+		z.Logger.Debug().Msgf("using %s = [%s]", name, s)
+		return s
+	}
+	z.Logger.Debug().Msgf("using %s = [%s] (default)", name, defaultValue)
+	return defaultValue
+}
+
 // load an int parameter or use defaultValue
 func (z *ZapiPerf) loadParamInt(name string, defaultValue int) int {
 
@@ -1318,9 +1341,9 @@ func (z *ZapiPerf) PollInstance() (map[string]*matrix.Matrix, error) {
 		queryElem := request.NewChildS("query", "")
 		infoElem := queryElem.NewChildS("qos-workload-info", "")
 		if z.Query == objWorkloadVolume || z.Query == objWorkloadDetailVolume {
-			infoElem.NewChildS("workload-class", "autovolume|user_defined|system_defined")
+			infoElem.NewChildS("workload-class", z.loadWorkloadClassQuery(objWorkloadVolumeClass))
 		} else {
-			infoElem.NewChildS("workload-class", "user_defined|system_defined")
+			infoElem.NewChildS("workload-class", z.loadWorkloadClassQuery(objWorkloadClass))
 		}
 
 		instancesAttr = "attributes-list"

cmd/tools/generate/counter.yaml

@@ -475,20 +475,6 @@ counters:
         Template: conf/zapiperf/9.12.0/workload_detail.yaml
         Unit: microseconds
 
-  - Name: qos_detail_volume_resource_latency
-    Description: average latency for volume on Data ONTAP subsystems
-    APIs:
-      - API: REST
-        Endpoint: api/cluster/counter/tables/qos_detail_volume
-        ONTAPCounter: Harvest generated
-        Template: conf/restperf/9.12.0/workload_detail_volume.yaml
-        Unit: microseconds
-      - API: ZAPI
-        Endpoint: perf-object-get-instances workload_detail_volume
-        ONTAPCounter: Harvest generated
-        Template: conf/zapiperf/9.12.0/workload_detail_volume.yaml
-        Unit: microseconds
-
   - Name: quota_disk_limit
     Description: Maximum amount of disk space, in kilobytes, allowed for the quota target
       (hard disk space limit). The value is -1 if the limit is unlimited.

conf/rest/9.12.0/qos_workload.yaml

@@ -0,0 +1,15 @@
+name:             QosWorkload
+query:            api/storage/qos/workloads
+object:           qos_workload
+
+counters:
+  - ^^uuid               => uuid
+  - ^name                => workload
+  - ^workload_class      => class
+
+export_options:
+  instance_keys:
+    - uuid
+  instance_labels:
+    - class
+    - workload

conf/rest/default.yaml

@@ -28,6 +28,7 @@ objects:
   OntapS3Policy:               ontap_s3_policy.yaml
   QosPolicyAdaptive:           qos_policy_adaptive.yaml
   QosPolicyFixed:              qos_policy_fixed.yaml
+  QosWorkload:                 qos_workload.yaml
   Qtree:                       qtree.yaml
   Security:                    security.yaml
   SecurityAccount:             security_account.yaml

conf/restperf/9.12.0/workload.yaml

@@ -6,6 +6,10 @@ object:                   qos
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - user_defined
+  - system_defined
+
 schedule:
   - counter:  1200s
   - instance: 600s

conf/restperf/9.12.0/workload_detail.yaml

@@ -7,6 +7,10 @@ object:                   qos_detail
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - user_defined
+  - system_defined
+
 schedule:
   - counter:  1200s
   - instance: 600s

conf/restperf/9.12.0/workload_detail_volume.yaml

@@ -2,10 +2,13 @@
 # object provides latency breakdown per service or delay center per volume
 name:                     WorkloadDetailVolume
 query:                    api/cluster/counter/tables/qos_detail_volume
-object:                   qos_detail_volume
+object:                   qos_detail
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - autovolume
+
 schedule:
   - counter: 1200s
   - instance: 600s

conf/restperf/9.12.0/workload_volume.yaml

@@ -4,10 +4,13 @@
 
 name:                     WorkloadVolume
 query:                    api/cluster/counter/tables/qos_volume
-object:                   qos_volume
+object:                   qos
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - autovolume
+
 schedule:
   - counter: 1200s
   - instance: 600s

conf/zapi/cdot/9.8.0/qos_workload.yaml

@@ -0,0 +1,18 @@
+name:             QosWorkload
+query:            qos-workload-get-iter
+object:           qos_workload
+
+counters:
+  qos-workload-info:
+    - ^^workload-uuid      => uuid
+    - ^workload-class      => class
+    - ^workload-name       => workload
+
+collect_only_labels: true
+
+export_options:
+  instance_keys:
+    - uuid
+  instance_labels:
+    - class
+    - workload

conf/zapi/default.yaml

@@ -19,6 +19,7 @@ objects:
   NtpServer:                   ntpserver.yaml
   QosPolicyAdaptive:           qos_policy_adaptive.yaml
   QosPolicyFixed:              qos_policy_fixed.yaml
+  QosWorkload:                 qos_workload.yaml
   Qtree:                       qtree.yaml
   Security:                    security.yaml
   SecurityAccount:             security_account.yaml

conf/zapiperf/cdot/9.8.0/workload.yaml

@@ -6,6 +6,9 @@ query:                    workload
 object:                   qos
 
 instance_key:             uuid
+workload_class:
+  - user_defined
+  - system_defined
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s

conf/zapiperf/cdot/9.8.0/workload_detail.yaml

@@ -9,6 +9,10 @@ instance_key:             name
 
 # recommended to use a large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - user_defined
+  - system_defined
+
 schedule:
   - counter: 1200s
   - instance: 600s

conf/zapiperf/cdot/9.8.0/workload_detail_volume.yaml

@@ -2,12 +2,15 @@
 # object provides latency breakdown per service or delay center per volume
 name:                     WorkloadDetailVolume
 query:                    workload_detail_volume
-object:                   qos_detail_volume
+object:                   qos_detail
 
 instance_key:             name
 
 # recommended to use a large interval, since workload objects are expensive
 client_timeout:           1m30s
+workload_class:
+  - autovolume
+
 schedule:
   - counter: 1200s
   - instance: 600s

conf/zapiperf/cdot/9.8.0/workload_volume.yaml

@@ -4,7 +4,7 @@
 
 name:                     WorkloadVolume
 query:                    workload_volume
-object:                   qos_volume
+object:                   qos
 
 # recommended to use large interval, since workload objects are expensive
 client_timeout:           1m30s
@@ -14,6 +14,8 @@ schedule:
   - data: 180s
 
 instance_key:             name
+workload_class:
+  - autovolume
 
 counters:
   - instance_name