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.

Sign up for GitHub

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

Jump to bottom

doc: update metric doc #3265

Merged
merged 1 commit into from
Nov 6, 2024
Merged

doc: update metric doc #3265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ this release:
- Add Emergency Events To Health Dashboard ([#3238](https://github.com/NetApp/harvest/pull/3238))
- Add Keyperf Metric Docs ([#3240](https://github.com/NetApp/harvest/pull/3240))
- Improve Harvest Memory Logging ([#3244](https://github.com/NetApp/harvest/pull/3244))
- Doctor should handle embedded exporters ([#3258](https://github.com/NetApp/harvest/pull/3258))

### :bug: Bug Fixes
- Handled Non Exported Qtrees In Template ([#3105](https://github.com/NetApp/harvest/pull/3105))
Expand All @@ -127,6 +128,7 @@ this release:
- Update Keyperf Collector Static Counter File Path ([#3241](https://github.com/NetApp/harvest/pull/3241))
- Fix Numbering In Quickstart ([#3249](https://github.com/NetApp/harvest/pull/3249))
- Fix Value Mapping In Tenant Dashboard ([#3253](https://github.com/NetApp/harvest/pull/3253))
- Rename volume latency in keyperf ([#3261](https://github.com/NetApp/harvest/pull/3261))

### :closed_book: Documentation
- Fix Typo In Docs ([#3112](https://github.com/NetApp/harvest/pull/3112))
Expand All @@ -136,6 +138,7 @@ this release:
- Remove Qos Service Latency Counter From Metric Docs ([#3188](https://github.com/NetApp/harvest/pull/3188))
- Add Space To Datacenter Dashboard Title ([#3225](https://github.com/NetApp/harvest/pull/3225))
- Update Release Months To Match Harvest Release Cadence ([#3236](https://github.com/NetApp/harvest/pull/3236))
- Update KeyPerf metric docs ([#3260](https://github.com/NetApp/harvest/pull/3260))

### :zap: Performance
- Reduce Allocs When Reading Credential Files ([#3111](https://github.com/NetApp/harvest/pull/3111))
Expand Down Expand Up @@ -191,7 +194,7 @@ this release:

---

## 24.05.8 / 2024-08-12 Release
## 24.08.0 / 2024-08-12 Release

- :gem: Harvest dashboards now include links to other relevant dashboards. This makes it easier to navigate relationships between cluster objects.

Expand Down
38 changes: 11 additions & 27 deletions docs/ontap-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7810,6 +7810,7 @@ Average latency in microseconds for the WAFL filesystem to process all the opera
| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `api/cluster/counter/tables/volume` | `average_latency`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> total_ops | conf/restperf/9.12.0/volume.yaml |
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |
| ZAPI | `perf-object-get-instances volume` | `avg_latency`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> total_ops | conf/zapiperf/cdot/9.8.0/volume.yaml |


Expand Down Expand Up @@ -8058,15 +8059,6 @@ This metric represents the total amount of data that has been read from and writ
| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/volume.yaml |


### node_volume_total_latency

Performance metric aggregated over all types of I/O operations. node_volume_total_latency is [volume_total_latency](#volume_total_latency) aggregated by `node`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |


### node_volume_total_ops

Number of operations per second serviced by the volume. node_volume_total_ops is [volume_total_ops](#volume_total_ops) aggregated by `node`.
Expand Down Expand Up @@ -14801,6 +14793,15 @@ Number of write operations per second to the volume
| ZAPI | `perf-object-get-instances volume:vserver` | `write_ops`<br><span class="key">Unit:</span> per_sec<br><span class="key">Type:</span> rate<br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/volume_svm.yaml |


### svm_volume_avg_latency

Performance metric aggregated over all types of I/O operations. svm_volume_avg_latency is [volume_avg_latency](#volume_avg_latency) aggregated by `svm`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |


### svm_volume_other_data

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. svm_volume_other_data is [volume_other_data](#volume_other_data) aggregated by `svm`.
Expand Down Expand Up @@ -14864,15 +14865,6 @@ Performance metric aggregated over all types of I/O operations. svm_volume_total
| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.total`<br><span class="key">Unit:</span> b_per_sec<br><span class="key">Type:</span> rate<br><span class="key">Base:</span> | conf/keyperf/9.15.0/volume.yaml |


### svm_volume_total_latency

Performance metric aggregated over all types of I/O operations. svm_volume_total_latency is [volume_total_latency](#volume_total_latency) aggregated by `svm`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |


### svm_volume_total_ops

Performance metric aggregated over all types of I/O operations. svm_volume_total_ops is [volume_total_ops](#volume_total_ops) aggregated by `svm`.
Expand Down Expand Up @@ -15139,6 +15131,7 @@ Average latency in microseconds for the WAFL filesystem to process all the opera
| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `api/cluster/counter/tables/volume` | `average_latency`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> total_ops | conf/restperf/9.12.0/volume.yaml |
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |
| ZAPI | `perf-object-get-instances volume` | `avg_latency`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> total_ops | conf/zapiperf/cdot/9.8.0/volume.yaml |


Expand Down Expand Up @@ -15861,15 +15854,6 @@ This metric represents the total amount of data that has been read from and writ
| ZAPI | `volume` | `read_data, write_data`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/volume.yaml |


### volume_total_latency

Performance metric aggregated over all types of I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.total`<br><span class="key">Unit:</span> microsec<br><span class="key">Type:</span> average<br><span class="key">Base:</span> volume_statistics.iops_raw.total | conf/keyperf/9.15.0/volume.yaml |


### volume_total_ops

Number of operations per second serviced by the volume
Expand Down