Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: disabled qtree perf template and update docs #3445

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions cmd/tools/generate/counter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion conf/restperf/default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion conf/zapiperf/default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 12 additions & 12 deletions docs/ontap-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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 |


Expand All @@ -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
Expand Down
31 changes: 24 additions & 7 deletions grafana/dashboards/cmode/qtree.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [],
Expand Down Expand Up @@ -145,7 +162,7 @@
"h": 10,
"w": 12,
"x": 0,
"y": 1
"y": 4
},
"id": 92,
"links": [],
Expand Down Expand Up @@ -235,7 +252,7 @@
"h": 10,
"w": 12,
"x": 12,
"y": 1
"y": 4
},
"id": 120,
"links": [],
Expand Down Expand Up @@ -327,7 +344,7 @@
"h": 10,
"w": 12,
"x": 0,
"y": 11
"y": 14
},
"id": 122,
"links": [],
Expand Down Expand Up @@ -419,7 +436,7 @@
"h": 10,
"w": 12,
"x": 12,
"y": 11
"y": 14
},
"id": 123,
"links": [],
Expand Down Expand Up @@ -459,7 +476,7 @@
"h": 1,
"w": 24,
"x": 0,
"y": 21
"y": 24
},
"id": 128,
"panels": [
Expand Down Expand Up @@ -988,5 +1005,5 @@
"timezone": "",
"title": "ONTAP: Qtree",
"uid": "cdot-qtree",
"version": 8
"version": 9
}
4 changes: 4 additions & 0 deletions integration/test/dashboard_json_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
Loading