feat: disabled qtree perf template and update docs (#3445)

* feat: disabled qtree perf template and update docs * feat: disabled qtree perf template and update docs * feat: handled review comments
NetApp · Jan 31, 2025 · 5522432 · 5522432
1 parent a761d08
commit 5522432
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 32 deletions.
diff --git a/cmd/tools/generate/counter.yaml b/cmd/tools/generate/counter.yaml
@@ -537,7 +537,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: space.hard_limit
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: disk-limit
@@ -549,7 +549,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: space.used.total
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: disk-used
@@ -561,7 +561,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: space.used.hard_limit_percent
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: disk-used-pct-disk-limit
@@ -573,7 +573,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: space.used.soft_limit_percent
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: disk-used-pct-soft-disk-limit
@@ -594,7 +594,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: files.hard_limit
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: file-limit
@@ -606,7 +606,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: files.used.total
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: files-used
@@ -619,7 +619,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: files.used.hard_limit_percent
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: files-used-pct-file-limit
@@ -632,7 +632,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: files.used.soft_limit_percent
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: files-used-pct-soft-file-limit
@@ -645,7 +645,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: space.soft_limit
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: soft-disk-limit
@@ -658,7 +658,7 @@ counters:
       - API: REST
         Endpoint: api/storage/quota/reports
         ONTAPCounter: files.soft_limit
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
       - API: ZAPI
         Endpoint: quota-report-iter
         ONTAPCounter: soft-file-limit
@@ -1110,7 +1110,7 @@ counters:
       - API: REST
         Endpoint: NA
         ONTAPCounter: Harvest generated
-        Template: conf/rest/9.12.0/qtree.yaml
+        Template: conf/rest/9.12.0/quota.yaml
 
   - Name: volume_space_performance_tier_inactive_user_data
     Description: The size that is physically used in the performance tier of the volume and has a cold temperature. This parameter is only supported if the volume is in an aggregate that is either attached to object store or could be attached to an object store.

diff --git a/conf/restperf/default.yaml b/conf/restperf/default.yaml
@@ -24,7 +24,7 @@ objects:
   Namespace:         namespace.yaml
   NicCommon:         nic_common.yaml
   Path:              path.yaml
-  Qtree:             qtree.yaml
+#  Qtree:             qtree.yaml
   Rwctx:             rwctx.yaml
   SystemNode:        system_node.yaml
 #  TokenManager:      token_manager.yaml

diff --git a/conf/zapiperf/default.yaml b/conf/zapiperf/default.yaml
@@ -29,7 +29,7 @@ objects:
   NicCommon:                nic_common.yaml
 #  ObjectStoreClient:        object_store_client_op.yaml
   Path:                     path.yaml
-  Qtree:                    qtree.yaml
+#  Qtree:                    qtree.yaml
   Rwctx:                    rwctx.yaml
   SystemNode:               system_node.yaml
 #  TokenManager:             token_manager.yaml

diff --git a/docs/ontap-metrics.md b/docs/ontap-metrics.md
@@ -7,7 +7,7 @@ These can be generated on demand by running `bin/harvest grafana metrics`. See
 - More information about ONTAP REST performance counters can be found [here](https://docs.netapp.com/us-en/ontap-pcmap-9121/index.html).
 
 ```
-Creation Date : 2025-Jan-17
+Creation Date : 2025-Jan-29
 ONTAP Version: 9.16.1
 ```
 ## Understanding the structure
@@ -10511,7 +10511,7 @@ Maximum amount of disk space, in kilobytes, allowed for the quota target (hard d
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `space.hard_limit` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `space.hard_limit` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `disk-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10521,7 +10521,7 @@ Current amount of disk space, in kilobytes, used by the quota target.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `space.used.total` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `space.used.total` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `disk-used` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10531,7 +10531,7 @@ Current disk space used expressed as a percentage of hard disk limit.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `space.used.hard_limit_percent` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `space.used.hard_limit_percent` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `disk-used-pct-disk-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10541,7 +10541,7 @@ Current disk space used expressed as a percentage of soft disk limit.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `space.used.soft_limit_percent` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `space.used.soft_limit_percent` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `disk-used-pct-soft-disk-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10560,7 +10560,7 @@ Maximum number of files allowed for the quota target (hard files limit). The val
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `files.hard_limit` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `files.hard_limit` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `file-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10570,7 +10570,7 @@ Current number of files used by the quota target.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `files.used.total` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `files.used.total` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `files-used` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10580,7 +10580,7 @@ Current number of files used expressed as a percentage of hard file limit.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `files.used.hard_limit_percent` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `files.used.hard_limit_percent` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `files-used-pct-file-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10590,7 +10590,7 @@ Current number of files used expressed as a percentage of soft file limit.
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `files.used.soft_limit_percent` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `files.used.soft_limit_percent` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `files-used-pct-soft-file-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10600,7 +10600,7 @@ soft disk space limit, in kilobytes, for the quota target. The value is -1 if th
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `space.soft_limit` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `space.soft_limit` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `soft-disk-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10610,7 +10610,7 @@ Soft file limit, in number of files, for the quota target. The value is -1 if th
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/storage/quota/reports` | `files.soft_limit` | conf/rest/9.12.0/qtree.yaml |
+| REST | `api/storage/quota/reports` | `files.soft_limit` | conf/rest/9.12.0/quota.yaml |
 | ZAPI | `quota-report-iter` | `soft-file-limit` | conf/zapi/cdot/9.8.0/qtree.yaml |
 
 
@@ -10621,7 +10621,7 @@ Disk space threshold, in kilobytes, for the quota target. The value is -1 if the
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
 | ZAPI | `quota-report-iter` | `threshold` | conf/zapi/cdot/9.8.0/qtree.yaml |
-| REST | `NA` | `Harvest generated` | conf/rest/9.12.0/qtree.yaml |
+| REST | `NA` | `Harvest generated` | conf/rest/9.12.0/quota.yaml |
 
 
 ### raid_disk_busy

diff --git a/grafana/dashboards/cmode/qtree.json b/grafana/dashboards/cmode/qtree.json
@@ -72,14 +72,31 @@
     }
   ],
   "panels": [
+    {
+      "datasource": "${DS_PROMETHEUS}",
+      "gridPos": {
+        "h": 3,
+        "w": 24,
+        "x": 0,
+        "y": 0
+      },
+      "id": 131,
+      "options": {
+        "content": "This dashboard requires enabling a qtree template. <br>Please see [How to enable qtree templates](https://github.com/NetApp/harvest/discussions/3446) for more details. Enabling `qtree.yaml` may slow down data collection.",
+        "mode": "markdown"
+      },
+      "pluginVersion": "8.1.8",
+      "title": "Important Information about Qtree dashboard",
+      "type": "text"
+    },
     {
       "collapsed": false,
       "datasource": "${DS_PROMETHEUS}",
       "gridPos": {
         "h": 1,
         "w": 24,
         "x": 0,
-        "y": 0
+        "y": 3
       },
       "id": 121,
       "panels": [],
@@ -145,7 +162,7 @@
         "h": 10,
         "w": 12,
         "x": 0,
-        "y": 1
+        "y": 4
       },
       "id": 92,
       "links": [],
@@ -235,7 +252,7 @@
         "h": 10,
         "w": 12,
         "x": 12,
-        "y": 1
+        "y": 4
       },
       "id": 120,
       "links": [],
@@ -327,7 +344,7 @@
         "h": 10,
         "w": 12,
         "x": 0,
-        "y": 11
+        "y": 14
       },
       "id": 122,
       "links": [],
@@ -419,7 +436,7 @@
         "h": 10,
         "w": 12,
         "x": 12,
-        "y": 11
+        "y": 14
       },
       "id": 123,
       "links": [],
@@ -459,7 +476,7 @@
         "h": 1,
         "w": 24,
         "x": 0,
-        "y": 21
+        "y": 24
       },
       "id": 128,
       "panels": [
@@ -988,5 +1005,5 @@
   "timezone": "",
   "title": "ONTAP: Qtree",
   "uid": "cdot-qtree",
-  "version": 8
+  "version": 9
 }
diff --git a/integration/test/dashboard_json_test.go b/integration/test/dashboard_json_test.go
@@ -115,6 +115,10 @@ var excludeCounters = []string{
 	"volume_top_files_",
 	// Based on the cluster upgrade, these metrics existence would be changed.
 	"cluster_software_",
+	"qtree_cifs_",
+	"qtree_nfs_",
+	"qtree_total_",
+	"qtree_internal_",
 }
 
 var flakyCounters = []string{