Skip to content

Commit

Permalink
feat: adding Rwctx template for RestPerf in 9.16.0 (#3349)
Browse files Browse the repository at this point in the history 
* feat: adding Rwctx template for RestPerf in 9.16.0

* feat: adding Rwctx docs
  • Loading branch information
@Hardikl
Hardikl authored Dec 3, 2024
1 parent 435c7d3 commit 70f27cf
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 19 deletions.
17 changes: 17 additions & 0 deletions conf/restperf/9.16.0/rwctx.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

name: Rwctx
query: api/cluster/counter/tables/rewind_context
object: rw_ctx

counters:
- ^^id
- ^node.name => node
- cifs_give_ups => cifs_giveups
- cifs_rewinds => cifs_rewinds
- nfs_give_ups => nfs_giveups
- nfs_rewinds => nfs_rewinds


export_options:
instance_keys:
- node
1 change: 1 addition & 0 deletions conf/restperf/default.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ objects:
NicCommon: nic_common.yaml
Path: path.yaml
Qtree: qtree.yaml
Rwctx: rwctx.yaml
SystemNode: system_node.yaml
# TokenManager: token_manager.yaml
VolumeNode: volume_node.yaml
Expand Down
42 changes: 23 additions & 19 deletions docs/ontap-metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ 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 : 2024-Nov-25
ONTAP Version: 9.15.1
Creation Date : 2024-Dec-02
ONTAP Version: 9.16.1
```
## Understanding the structure

Expand Down Expand Up @@ -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 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 <i>fields</i> 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 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 <i>fields</i> query parameter containing either footprint or **.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -1031,7 +1031,7 @@ The aggregate's volume count, which includes both FlexVols and FlexGroup constit

### aggr_write_data

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -1040,7 +1040,7 @@ Peformance metric for write I/O operations.

### aggr_write_latency

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -1049,7 +1049,7 @@ Peformance metric for write I/O operations.

### aggr_write_ops

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -1245,7 +1245,7 @@ Performance metric aggregated over all types of I/O operations.

### cluster_write_data

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -1254,7 +1254,7 @@ Peformance metric for write I/O operations.

### cluster_write_latency

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -1263,7 +1263,7 @@ Peformance metric for write I/O operations.

### cluster_write_ops

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -10427,7 +10427,7 @@ Summation of NFS ops, CIFS ops, CSS ops and internal ops

### qtree_write_data

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -10436,7 +10436,7 @@ Peformance metric for write I/O operations.

### qtree_write_ops

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -10734,37 +10734,41 @@ Number of disk write operations initiated each second for storing data or metada

### rw_ctx_cifs_giveups

Array of number of given-ups of cifs ops because they rewind more than a certain threshold, categorized by their rewind reasons.
Array of number of give-ups of CIFS ops because they rewind more than a certain threshold, categorized by their rewind reasons.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `api/cluster/counter/tables/rewind_context` | `cifs_give_ups`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/restperf/9.16.0/rwctx.yaml |
| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_giveups`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/rwctx.yaml |


### rw_ctx_cifs_rewinds

Array of number of rewinds for cifs ops based on their reasons.
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`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/restperf/9.16.0/rwctx.yaml |
| ZAPI | `perf-object-get-instances rw_ctx` | `cifs_rewinds`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/rwctx.yaml |


### rw_ctx_nfs_giveups

Array of number of given-ups of nfs ops because they rewind more than a certain threshold, categorized by their rewind reasons.
Array of number of give-ups of NFS ops because they rewind more than a certain threshold, categorized by their rewind reasons.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `api/cluster/counter/tables/rewind_context` | `nfs_give_ups`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/restperf/9.16.0/rwctx.yaml |
| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_giveups`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/rwctx.yaml |


### rw_ctx_nfs_rewinds

Array of number of rewinds for nfs ops based on their reasons.
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`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/restperf/9.16.0/rwctx.yaml |
| ZAPI | `perf-object-get-instances rw_ctx` | `nfs_rewinds`<br><span class="key">Unit:</span> none<br><span class="key">Type:</span> delta<br><span class="key">Base:</span> | conf/zapiperf/cdot/9.8.0/rwctx.yaml |


Expand Down Expand Up @@ -11553,7 +11557,7 @@ Performance metric aggregated over all types of I/O operations.

### svm_cifs_write_data

Peformance metric for write I/O operations.
Performance metric for write I/O operations.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -14924,7 +14928,7 @@ Performance metric aggregated over all types of I/O operations. svm_volume_total

### svm_volume_write_data

Peformance metric for write I/O operations. svm_volume_write_data is [volume_write_data](#volume_write_data) aggregated by `svm`.
Performance metric for write I/O operations. svm_volume_write_data is [volume_write_data](#volume_write_data) aggregated by `svm`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -14933,7 +14937,7 @@ Peformance metric for write I/O operations. svm_volume_write_data is [volume_wri

### svm_volume_write_latency

Peformance metric for write I/O operations. svm_volume_write_latency is [volume_write_latency](#volume_write_latency) aggregated by `svm`.
Performance metric for write I/O operations. svm_volume_write_latency is [volume_write_latency](#volume_write_latency) aggregated by `svm`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -14942,7 +14946,7 @@ Peformance metric for write I/O operations. svm_volume_write_latency is [volume_

### svm_volume_write_ops

Peformance metric for write I/O operations. svm_volume_write_ops is [volume_write_ops](#volume_write_ops) aggregated by `svm`.
Performance metric for write I/O operations. svm_volume_write_ops is [volume_write_ops](#volume_write_ops) aggregated by `svm`.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down

0 comments on commit 70f27cf

Please sign in to comment.