diff --git a/docs/ontap-metrics.md b/docs/ontap-metrics.md index 2a81282b0..311683e61 100644 --- a/docs/ontap-metrics.md +++ b/docs/ontap-metrics.md @@ -455,7 +455,7 @@ Number of user-visible files used in the referenced file system. If the referenc ### aggr_inode_inodefile_private_capacity -Number of files that can currently be stored on disk for system metadata files. This number will dynamically increase as more system files are created.This is an advanced property; there is an added computational cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **. +Number of files that can currently be stored on disk for system metadata files. This number will dynamically increase as more system files are created.This is an advanced property; there is an added computationl cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1031,7 +1031,7 @@ The aggregate's volume count, which includes both FlexVols and FlexGroup constit ### aggr_write_data -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1040,7 +1040,7 @@ Performance metric for write I/O operations. ### aggr_write_latency -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1049,7 +1049,7 @@ Performance metric for write I/O operations. ### aggr_write_ops -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1245,7 +1245,7 @@ Performance metric aggregated over all types of I/O operations. ### cluster_write_data -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1254,7 +1254,7 @@ Performance metric for write I/O operations. ### cluster_write_latency -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -1263,7 +1263,7 @@ Performance metric for write I/O operations. ### cluster_write_ops -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -3683,6 +3683,7 @@ Average read latency in microseconds for all operations on the LUN | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `average_read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.latency_raw.read`
Unit: microsec
Type: average
Base: lun_statistics.iops_raw.read | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `avg_read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -3693,6 +3694,7 @@ Average write latency in microseconds for all operations on the LUN | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `average_write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.latency_raw.write`
Unit: microsec
Type: average
Base: lun_statistics.iops_raw.write | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `avg_write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -3736,6 +3738,33 @@ This metric indicates a value of 1 if the LUN state is online (indicating the LU | ZAPI | `NA` | `Harvest generated` | conf/zapi/cdot/9.8.0/lun.yaml | +### lun_other_data + +Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.throughput_raw.other`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | + + +### lun_other_latency + +Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.latency_raw.other`
Unit: microsec
Type: average
Base: lun_statistics.iops_raw.other | conf/keyperf/9.15.0/lun.yaml | + + +### lun_other_ops + +Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.iops_raw.other`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | + + ### lun_queue_full Queue full responses @@ -3763,6 +3792,7 @@ Read bytes | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.throughput_raw.read`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -3773,6 +3803,7 @@ Number of read operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.iops_raw.read`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -3836,6 +3867,33 @@ This metric represents the percentage of a LUN that is currently being used. | ZAPI | `lun-get-iter` | `size_used, size` | conf/zapi/cdot/9.8.0/lun.yaml | +### lun_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.throughput_raw.total`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | + + +### lun_total_latency + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.latency_raw.total`
Unit: microsec
Type: average
Base: lun_statistics.iops_raw.total | conf/keyperf/9.15.0/lun.yaml | + + +### lun_total_ops + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/luns` | `statistics.iops_raw.total`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | + + ### lun_unmap_reqs Number of unmap command requests @@ -3863,6 +3921,7 @@ Write bytes | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.throughput_raw.write`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -3873,6 +3932,7 @@ Number of write operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lun` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/lun.yaml | +| KeyPerf | `api/storage/luns` | `statistics.iops_raw.write`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/lun.yaml | | ZAPI | `perf-object-get-instances lun` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lun.yaml | @@ -4159,6 +4219,7 @@ Average other ops latency in microseconds for all operations on the Namespace | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `average_other_latency`
Unit: microsec
Type: average
Base: other_ops | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.latency_raw.other`
Unit: microsec
Type: average
Base: namespace_statistics.iops_raw.other | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `avg_other_latency`
Unit: microsec
Type: average
Base: other_ops | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4169,9 +4230,19 @@ Average read latency in microseconds for all operations on the Namespace | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `average_read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.latency_raw.read`
Unit: microsec
Type: average
Base: namespace_statistics.iops_raw.read | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `avg_read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/zapiperf/cdot/9.10.1/namespace.yaml | +### namespace_avg_total_latency + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/namespaces` | `statistics.latency_raw.total`
Unit: microsec
Type: average
Base: namespace_statistics.iops_raw.total | conf/keyperf/9.15.0/namespace.yaml | + + ### namespace_avg_write_latency Average write latency in microseconds for all operations on the Namespace @@ -4179,6 +4250,7 @@ Average write latency in microseconds for all operations on the Namespace | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `average_write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.latency_raw.write`
Unit: microsec
Type: average
Base: namespace_statistics.iops_raw.write | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `avg_write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4199,6 +4271,7 @@ Number of other operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `other_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.iops_raw.other`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `other_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4209,6 +4282,7 @@ Read bytes | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.throughput_raw.read`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4219,6 +4293,7 @@ Number of read operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.iops_raw.read`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4282,6 +4357,24 @@ The amount of space consumed by the main data stream of the NVMe namespace.
| ZAPI | `nvme-namespace-get-iter` | `nvme-namespace-info.size-used` | conf/zapi/cdot/9.8.0/namespace.yaml | +### namespace_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/namespaces` | `statistics.throughput_raw.total`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | + + +### namespace_total_ops + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/namespaces` | `statistics.iops_raw.total`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | + + ### namespace_write_data Write bytes @@ -4289,6 +4382,7 @@ Write bytes | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.throughput_raw.write`
Unit: b_per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -4299,6 +4393,7 @@ Number of write operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/namespace` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/namespace.yaml | +| KeyPerf | `api/storage/namespaces` | `statistics.iops_raw.write`
Unit: per_sec
Type: rate
Base: | conf/keyperf/9.15.0/namespace.yaml | | ZAPI | `perf-object-get-instances namespace` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.10.1/namespace.yaml | @@ -10427,7 +10522,7 @@ Summation of NFS ops, CIFS ops, CSS ops and internal ops ### qtree_write_data -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -10436,7 +10531,7 @@ Performance metric for write I/O operations. ### qtree_write_ops -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -10739,7 +10834,7 @@ Array of number of give-ups of CIFS ops because they rewind more than a certain | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/rewind_context` | `cifs_give_ups`
Unit: none
Type: delta
Base: | conf/restperf/9.16.0/rwctx.yaml | -| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_giveups`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | +| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_giveups`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | ### rw_ctx_cifs_rewinds @@ -10749,7 +10844,7 @@ Array of number of rewinds for CIFS ops based on their reasons. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/rewind_context` | `cifs_rewinds`
Unit: none
Type: delta
Base: | conf/restperf/9.16.0/rwctx.yaml | -| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_rewinds`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | +| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_rewinds`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | ### rw_ctx_nfs_giveups @@ -10759,7 +10854,7 @@ Array of number of give-ups of NFS ops because they rewind more than a certain t | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/rewind_context` | `nfs_give_ups`
Unit: none
Type: delta
Base: | conf/restperf/9.16.0/rwctx.yaml | -| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_giveups`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | +| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_giveups`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | ### rw_ctx_nfs_rewinds @@ -10769,7 +10864,7 @@ Array of number of rewinds for NFS ops based on their reasons. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/rewind_context` | `nfs_rewinds`
Unit: none
Type: delta
Base: | conf/restperf/9.16.0/rwctx.yaml | -| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_rewinds`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | +| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_rewinds`
Unit: none
Type: delta
Base: | conf/zapiperf/cdot/9.8.0/rwctx.yaml | ### rw_ctx_qos_flowcontrol @@ -11414,7 +11509,7 @@ Total Number of Schedules in this Policy | API | Endpoint | Metric | Template | |--------|----------|--------|---------| -| REST | `api/private/cli/snapshot/policy` | `total_schedules` | conf/rest/9.12.0/snapshotpolicy.yaml | +| REST | `api/private/cli/volume/snapshot/policy` | `total_schedules` | conf/rest/9.12.0/snapshotpolicy.yaml | | ZAPI | `snapshot-policy-get-iter` | `snapshot-policy-info.total-schedules` | conf/zapi/cdot/9.8.0/snapshotpolicy.yaml | @@ -11557,7 +11652,7 @@ Performance metric aggregated over all types of I/O operations. ### svm_cifs_write_data -Performance metric for write I/O operations. +Peformance metric for write I/O operations. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -14928,7 +15023,7 @@ Performance metric aggregated over all types of I/O operations. svm_volume_total ### svm_volume_write_data -Performance metric for write I/O operations. svm_volume_write_data is [volume_write_data](#volume_write_data) aggregated by `svm`. +Peformance metric for write I/O operations. svm_volume_write_data is [volume_write_data](#volume_write_data) aggregated by `svm`. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -14937,7 +15032,7 @@ Performance metric for write I/O operations. svm_volume_write_data is [volume_wr ### svm_volume_write_latency -Performance metric for write I/O operations. svm_volume_write_latency is [volume_write_latency](#volume_write_latency) aggregated by `svm`. +Peformance metric for write I/O operations. svm_volume_write_latency is [volume_write_latency](#volume_write_latency) aggregated by `svm`. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| @@ -14946,7 +15041,7 @@ Performance metric for write I/O operations. svm_volume_write_latency is [volume ### svm_volume_write_ops -Performance metric for write I/O operations. svm_volume_write_ops is [volume_write_ops](#volume_write_ops) aggregated by `svm`. +Peformance metric for write I/O operations. svm_volume_write_ops is [volume_write_ops](#volume_write_ops) aggregated by `svm`. | API | Endpoint | Metric | Template | |--------|----------|--------|---------|