From fb526e729eddb7b358159c9bd42dcf94e714ef69 Mon Sep 17 00:00:00 2001 From: rahulguptajss Date: Wed, 30 Oct 2024 16:50:45 +0530 Subject: [PATCH 1/2] feat: add keyperf metric docs --- cmd/tools/generate/counter.go | 42 +- conf/keyperf/9.15.0/cifs_vserver.yaml | 1 - conf/keyperf/9.15.0/lun.yaml | 39 -- conf/keyperf/9.15.0/namespace.yaml | 38 -- docs/ontap-metrics.md | 573 +++++++++++++++++++++++++- 5 files changed, 607 insertions(+), 86 deletions(-) delete mode 100644 conf/keyperf/9.15.0/lun.yaml delete mode 100644 conf/keyperf/9.15.0/namespace.yaml diff --git a/cmd/tools/generate/counter.go b/cmd/tools/generate/counter.go index 9f18ac8b5..89f08a8a8 100644 --- a/cmd/tools/generate/counter.go +++ b/cmd/tools/generate/counter.go @@ -41,6 +41,9 @@ var ( "security_ssh": "cluster_ssh_server", "namespace": "nvme_namespace", "fcp": "fc_port", + "svm_cifs": "cifs_service", + "svm_nfs": "nfs_service", + "lif": "ip_interface", } swaggerBytes []byte excludePerfTemplates = map[string]struct{}{ @@ -278,12 +281,30 @@ func processRestCounters(dir string, client *rest.Client) map[string]Counter { }) restCounters := visitRestTemplates(filepath.Join(dir, "conf", "rest"), client, func(path string, client *rest.Client) map[string]Counter { // revive:disable-line:unused-parameter - return processRestConfigCounters(path) + return processRestConfigCounters(path, "REST") + }) + + keyPerfCounters := visitRestTemplates(filepath.Join(dir, "conf", "keyperf"), client, func(path string, client *rest.Client) map[string]Counter { // revive:disable-line:unused-parameter + return processRestConfigCounters(path, "KeyPerf") }) for k, v := range restPerfCounters { restCounters[k] = v } + + keyPerfKeys := slices.Sorted(maps.Keys(keyPerfCounters)) + for _, k := range keyPerfKeys { + if strings.Contains(k, "timestamp") || strings.Contains(k, "labels") { + continue + } + v := keyPerfCounters[k] + if v1, ok := restCounters[k]; !ok { + restCounters[k] = v + } else { + v1.APIs = append(v1.APIs, v.APIs...) + restCounters[k] = v1 + } + } return restCounters } @@ -358,7 +379,7 @@ func handleZapiCounter(path []string, content string, object string) (string, st } // processRestConfigCounters process Rest config templates -func processRestConfigCounters(path string) map[string]Counter { +func processRestConfigCounters(path string, api string) map[string]Counter { var ( counters = make(map[string]Counter) ) @@ -383,7 +404,7 @@ func processRestConfigCounters(path string) map[string]Counter { if templateCounters != nil { metricLabels, labels = getAllExportedLabels(t, templateCounters.GetAllChildContentS()) - processCounters(templateCounters.GetAllChildContentS(), &model, path, model.Query, counters, metricLabels) + processCounters(templateCounters.GetAllChildContentS(), &model, path, model.Query, counters, metricLabels, api) // This is for object_labels metrics harvestName := model.Object + "_" + "labels" counters[harvestName] = Counter{Name: harvestName, Labels: labels} @@ -398,7 +419,7 @@ func processRestConfigCounters(path string) map[string]Counter { query = line.GetContentS() } if line.GetNameS() == "counters" { - processCounters(line.GetAllChildContentS(), &model, path, query, counters, metricLabels) + processCounters(line.GetAllChildContentS(), &model, path, query, counters, metricLabels, api) } } } @@ -411,7 +432,7 @@ func processRestConfigCounters(path string) map[string]Counter { Name: model.Object + "_" + metric.Name, APIs: []MetricDef{ { - API: "REST", + API: api, Endpoint: model.Query, Template: path, ONTAPCounter: metric.Source, @@ -423,10 +444,17 @@ func processRestConfigCounters(path string) map[string]Counter { } } + if api == "KeyPerf" { + // handling for templates with common object names + if specialPerfObjects[model.Object] { + return specialHandlingPerfCounters(counters, model) + } + } + return counters } -func processCounters(counterContents []string, model *template2.Model, path, query string, counters map[string]Counter, metricLabels []string) { +func processCounters(counterContents []string, model *template2.Model, path, query string, counters map[string]Counter, metricLabels []string, api string) { for _, c := range counterContents { if c == "" { continue @@ -444,7 +472,7 @@ func processCounters(counterContents []string, model *template2.Model, path, que Description: description, APIs: []MetricDef{ { - API: "REST", + API: api, Endpoint: query, Template: path, ONTAPCounter: name, diff --git a/conf/keyperf/9.15.0/cifs_vserver.yaml b/conf/keyperf/9.15.0/cifs_vserver.yaml index 32a9d784b..63603e47b 100644 --- a/conf/keyperf/9.15.0/cifs_vserver.yaml +++ b/conf/keyperf/9.15.0/cifs_vserver.yaml @@ -14,7 +14,6 @@ counters: - statistics.latency_raw.read => read_latency - statistics.latency_raw.total => total_latency - statistics.latency_raw.write => write_latency - - statistics.throughput_raw.other => other_data - statistics.throughput_raw.read => read_data - statistics.throughput_raw.write => write_data - statistics.timestamp(timestamp) => timestamp diff --git a/conf/keyperf/9.15.0/lun.yaml b/conf/keyperf/9.15.0/lun.yaml deleted file mode 100644 index af7a65d79..000000000 --- a/conf/keyperf/9.15.0/lun.yaml +++ /dev/null @@ -1,39 +0,0 @@ -name: Lun -query: api/storage/luns -object: lun - -counters: - - ^^uuid => uuid - - ^location.volume.name => volume - - ^name => path - - ^statistics.status => status - - ^svm.name => svm - - statistics.iops_raw.other => other_ops - - statistics.iops_raw.read => read_ops - - statistics.iops_raw.total => total_ops - - statistics.iops_raw.write => write_ops - - statistics.latency_raw.other => other_latency - - statistics.latency_raw.read => avg_read_latency - - statistics.latency_raw.total => total_latency - - statistics.latency_raw.write => avg_write_latency - - statistics.throughput_raw.other => other_data - - statistics.throughput_raw.read => read_data - - statistics.throughput_raw.total => total_data - - statistics.throughput_raw.write => write_data - - statistics.timestamp(timestamp) => timestamp - - hidden_fields: - - statistics - - filter: - - statistics.timestamp=!"-" - -plugins: - LabelAgent: - split_regex: - - path `^/[^/]+/([^/]+)(?:/.*?|)/([^/]+)$` volume,lun - - path `^([^/]+)$` lun - -export_options: - instance_keys: - - lun - - svm - - volume diff --git a/conf/keyperf/9.15.0/namespace.yaml b/conf/keyperf/9.15.0/namespace.yaml deleted file mode 100644 index 88eaaedbe..000000000 --- a/conf/keyperf/9.15.0/namespace.yaml +++ /dev/null @@ -1,38 +0,0 @@ -name: Namespace -query: api/storage/namespaces -object: namespace - -counters: - - ^^uuid => uuid - - ^name => path - - ^statistics.status => status - - ^svm.name => svm - - statistics.iops_raw.other => other_ops - - statistics.iops_raw.read => read_ops - - statistics.iops_raw.total => total_ops - - statistics.iops_raw.write => write_ops - - statistics.latency_raw.other => avg_other_latency - - statistics.latency_raw.read => avg_read_latency - - statistics.latency_raw.total => avg_total_latency - - statistics.latency_raw.write => avg_write_latency - - statistics.throughput_raw.other => other_data - - statistics.throughput_raw.read => read_data - - statistics.throughput_raw.total => total_data - - statistics.throughput_raw.write => write_data - - statistics.timestamp(timestamp) => timestamp - - hidden_fields: - - statistics - - filter: - - statistics.timestamp=!"-" - -plugins: - LabelAgent: - split: - - path `/` ,,volume,namespace - -export_options: - instance_keys: - - namespace - - path - - svm - - volume diff --git a/docs/ontap-metrics.md b/docs/ontap-metrics.md index b84092e80..312773df8 100644 --- 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 : 2024-Oct-24 +Creation Date : 2024-Oct-30 ONTAP Version: 9.15.1 ``` ## Understanding the structure @@ -561,6 +561,33 @@ Physical space usage of aggregates in the attached object store. | REST | `api/private/cli/aggr/show-space` | `object_store_physical_used` | conf/rest/9.12.0/aggr.yaml | +### aggr_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/aggregates` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_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/aggregates` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_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/aggregates` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + ### aggr_physical_used_wo_snapshots Total Data Reduction Physical Used Without Snapshots @@ -630,6 +657,33 @@ Option to specify the maximum number of disks that can be included in a RAID gro | ZAPI | `aggr-get-iter` | `aggr-attributes.aggr-raid-attributes.raid-size` | conf/zapi/cdot/9.8.0/aggr.yaml | +### aggr_read_data + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_read_latency + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_read_ops + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + ### aggr_snapshot_files_total Total files allowed in Snapshot copies @@ -918,6 +972,24 @@ The percentage of disk space currently in use on the referenced file system | ZAPI | `aggr-get-iter` | `aggr-attributes.aggr-space-attributes.percent-used-capacity` | conf/zapi/cdot/9.8.0/aggr.yaml | +### aggr_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_total_latency + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + ### aggr_total_logical_used Logical used @@ -928,6 +1000,15 @@ Logical used | ZAPI | `aggr-efficiency-get-iter` | `aggr-efficiency-info.aggr-efficiency-cumulative-info.total-logical-used` | conf/zapi/cdot/9.9.0/aggr_efficiency.yaml | +### aggr_total_ops + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + ### aggr_total_physical_used Total Physical Used @@ -948,6 +1029,33 @@ The aggregate's volume count, which includes both FlexVols and FlexGroup constit | ZAPI | `aggr-get-iter` | `aggr-attributes.aggr-volume-count-attributes.flexvol-count` | conf/zapi/cdot/9.8.0/aggr.yaml | +### aggr_write_data + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_write_latency + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + +### aggr_write_ops + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/aggregates` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/aggr.yaml | + + ### cifs_session_connection_count A counter used to track requests that are sent to the volumes to the node. @@ -978,6 +1086,33 @@ It is an indicator of the overall health status of the cluster, with a value of | ZAPI | `NA` | `Harvest generated` | conf/zapi/cdot/9.8.0/status.yaml | +### cluster_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/cluster` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_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/cluster` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_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/cluster` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + ### cluster_peer_non_encrypted This metric indicates a value of 1 if the cluster peer encryption state is none (indicating the connection is not encrypted) and a value of 0 for any other state. @@ -988,6 +1123,33 @@ This metric indicates a value of 1 if the cluster peer encryption state is none | ZAPI | `NA` | `Harvest generated` | conf/zapi/cdot/9.8.0/clusterpeer.yaml | +### cluster_read_data + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_read_latency + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_read_ops + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + ### cluster_subsystem_new_status This metric indicates a value of 1 if the subsystem health is ok (indicating the subsystem is operational) and a value of 0 for any other health status. @@ -1018,6 +1180,60 @@ Number of suppressed alerts | ZAPI | `diagnosis-subsystem-config-get-iter` | `diagnosis-subsystem-config-info.suppressed-alert-count` | conf/zapi/cdot/9.8.0/subsystem.yaml | +### cluster_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_total_latency + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_total_ops + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_write_data + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_write_latency + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + +### cluster_write_ops + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/cluster` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cluster.yaml | + + ### copy_manager_bce_copy_count_curr Current number of copy requests being processed by the Block Copy Engine. @@ -3339,6 +3555,7 @@ Number of bytes received per second | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lif` | `received_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/lif.yaml | +| KeyPerf | `api/network/ip/interfaces` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/lif.yaml | | ZAPI | `perf-object-get-instances lif` | `recv_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lif.yaml | @@ -3369,6 +3586,7 @@ Number of bytes sent per second | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/lif` | `sent_data`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/lif.yaml | +| KeyPerf | `api/network/ip/interfaces` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/lif.yaml | | ZAPI | `perf-object-get-instances lif` | `sent_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lif.yaml | @@ -3392,6 +3610,15 @@ Number of packets sent per second | ZAPI | `perf-object-get-instances lif` | `sent_packet`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/lif.yaml | +### lif_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/network/ip/interfaces` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/lif.yaml | + + ### lun_avg_read_latency Average read latency in microseconds for all operations on the LUN @@ -4654,6 +4881,7 @@ Average processor utilization across active processors in the system | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/system:node` | `average_processor_busy_percent`
Unit: percent
Type: percent
Base: cpu_elapsed_time | conf/restperf/9.12.0/system_node.yaml | +| KeyPerf | `api/cluster/nodes` | `statistics.processor_utilization_raw`
Unit:
Type:
Base: | conf/keyperf/9.15.0/node.yaml | | ZAPI | `perf-object-get-instances system:node` | `avg_processor_busy`
Unit: percent
Type: percent
Base: cpu_elapsed_time | conf/zapiperf/cdot/9.8.0/system_node.yaml | @@ -7746,6 +7974,15 @@ Number of NFS write operations per second to the volume. node_volume_nfs_write_o | ZAPI | `perf-object-get-instances volume` | `nfs_write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | +### node_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. node_volume_other_data is [volume_other_data](#volume_other_data) aggregated by `node`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + ### node_volume_other_latency Average latency in microseconds for the WAFL filesystem to process other operations to the volume; not including request processing or network communication time. node_volume_other_latency is [volume_other_latency](#volume_other_latency) aggregated by `node`. @@ -7753,6 +7990,7 @@ Average latency in microseconds for the WAFL filesystem to process other operati | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `other_latency`
Unit: microsec
Type: average
Base: total_other_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `other_latency`
Unit: microsec
Type: average
Base: other_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7763,6 +8001,7 @@ Number of other operations per second to the volume. node_volume_other_ops is [v | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_other_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `other_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7773,6 +8012,7 @@ Bytes read per second. node_volume_read_data is [volume_read_data](#volume_read_ | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `bytes_read`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7783,6 +8023,7 @@ Average latency in microseconds for the WAFL filesystem to process read request | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `read_latency`
Unit: microsec
Type: average
Base: total_read_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7793,6 +8034,7 @@ Number of read operations per second from the volume. node_volume_read_ops is [v | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7802,10 +8044,20 @@ This metric represents the total amount of data that has been read from and writ | API | Endpoint | Metric | Template | |--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | REST | `NA` | `Harvest generated`
Unit:
Type:
Base: | conf/restperf/9.12.0/volume.yaml | | ZAPI | `NA` | `Harvest generated`
Unit:
Type:
Base: | 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`
Unit:
Type:
Base: | 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`. @@ -7813,6 +8065,7 @@ Number of operations per second serviced by the volume. node_volume_total_ops is | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7823,6 +8076,7 @@ Bytes written per second. node_volume_write_data is [volume_write_data](#volume_ | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `bytes_written`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7833,6 +8087,7 @@ Average latency in microseconds for the WAFL filesystem to process write request | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `write_latency`
Unit: microsec
Type: average
Base: total_write_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -7843,6 +8098,7 @@ Number of write operations per second to the volume. node_volume_write_ops is [v | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -10064,6 +10320,51 @@ Number of NFS operations per second to the qtree | ZAPI | `perf-object-get-instances qtree` | `nfs_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/qtree.yaml | +### qtree_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/qtrees` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + +### qtree_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/qtrees` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + +### qtree_read_data + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/qtrees` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + +### qtree_read_ops + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/qtrees` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + +### qtree_total_data + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/qtrees` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + ### qtree_total_ops Summation of NFS ops, CIFS ops, CSS ops and internal ops @@ -10071,9 +10372,28 @@ Summation of NFS ops, CIFS ops, CSS ops and internal ops | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/qtree` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/qtree.yaml | +| KeyPerf | `api/storage/qtrees` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | | ZAPI | `perf-object-get-instances qtree` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/qtree.yaml | +### qtree_write_data + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/qtrees` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + +### qtree_write_ops + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/qtrees` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/qtree.yaml | + + ### quota_disk_limit Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is -1 if the limit is unlimited. @@ -11105,6 +11425,33 @@ Total number of CIFS operations | ZAPI | `perf-object-get-instances cifs:vserver` | `cifs_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | +### svm_cifs_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/protocols/cifs/services` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + +### svm_cifs_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/protocols/cifs/services` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + +### svm_cifs_read_data + +Performance metric for read I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/protocols/cifs/services` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + ### svm_cifs_read_latency Average latency for CIFS read operations @@ -11112,6 +11459,7 @@ Average latency for CIFS read operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_cifs` | `average_read_latency`
Unit: microsec
Type: average
Base: total_read_ops | conf/restperf/9.12.0/cifs_vserver.yaml | +| KeyPerf | `api/protocols/cifs/services` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | | ZAPI | `perf-object-get-instances cifs:vserver` | `cifs_read_latency`
Unit: microsec
Type: average
Base: cifs_read_ops | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | @@ -11122,6 +11470,7 @@ Total number of CIFS read operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_cifs` | `total_read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/cifs_vserver.yaml | +| KeyPerf | `api/protocols/cifs/services` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | | ZAPI | `perf-object-get-instances cifs:vserver` | `cifs_read_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | @@ -11135,6 +11484,33 @@ Number of signed SMB and SMB2 sessions. | ZAPI | `perf-object-get-instances cifs:vserver` | `signed_sessions`
Unit: none
Type: raw
Base: | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | +### svm_cifs_total_latency + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/protocols/cifs/services` | `statistics.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + +### svm_cifs_total_ops + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/protocols/cifs/services` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + +### svm_cifs_write_data + +Peformance metric for write I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/protocols/cifs/services` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | + + ### svm_cifs_write_latency Average latency for CIFS write operations @@ -11142,6 +11518,7 @@ Average latency for CIFS write operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_cifs` | `average_write_latency`
Unit: microsec
Type: average
Base: total_write_ops | conf/restperf/9.12.0/cifs_vserver.yaml | +| KeyPerf | `api/protocols/cifs/services` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | | ZAPI | `perf-object-get-instances cifs:vserver` | `cifs_write_latency`
Unit: microsec
Type: average
Base: cifs_write_ops | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | @@ -11152,6 +11529,7 @@ Total number of CIFS write operations | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_cifs` | `total_write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/cifs_vserver.yaml | +| KeyPerf | `api/protocols/cifs/services` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/cifs_vserver.yaml | | ZAPI | `perf-object-get-instances cifs:vserver` | `cifs_write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/cifs_vserver.yaml | @@ -11692,8 +12070,11 @@ Average latency of NFSv3 requests. This counter keeps track of the average respo | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `latency`
Unit: microsec
Type: average
Base: total_ops | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `latency`
Unit: microsec
Type: average
Base: total_ops | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `latency`
Unit: microsec
Type: average
Base: total_ops | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.latency_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `latency`
Unit: microsec
Type: average
Base: total_ops | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `latency`
Unit: microsec
Type: average,no-zero-values
Base: total_ops | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `latency`
Unit: microsec
Type: average,no-zero-values
Base: total_ops | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -12160,8 +12541,11 @@ Total number of NFSv3 procedure requests per second. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `nfsv3_ops`
Unit: per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `total_ops`
Unit: per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -12169,6 +12553,28 @@ Total number of NFSv3 procedure requests per second. | ZAPI | `perf-object-get-instances nfsv4_2` | `total_ops`
Unit: per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.11.0/nfsv4_2.yaml | +### svm_nfs_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/protocols/nfs/services` | `statistics.v3.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | + + +### svm_nfs_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/protocols/nfs/services` | `statistics.v3.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | + + ### svm_nfs_pathconf_avg_latency Average latency of PathConf procedure requests. The counter keeps track of the average response time of PathConf requests. @@ -12280,8 +12686,11 @@ Average latency of Read procedure requests. The counter keeps track of the avera | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `read.average_latency`
Unit: microsec
Type: average
Base: read.total | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `read.average_latency`
Unit: microsec
Type: average
Base: read.total | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `read.average_latency`
Unit: microsec
Type: average
Base: read.total | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `read.average_latency`
Unit: microsec
Type: average
Base: read.total | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `read_avg_latency`
Unit: microsec
Type: average,no-zero-values
Base: read_total | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `read_avg_latency`
Unit: microsec
Type: average,no-zero-values
Base: read_total | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -12296,6 +12705,9 @@ Total observed NFSv3 read operations per second. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `nfsv3_read_ops`
Unit: per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | @@ -12326,8 +12738,11 @@ Rate of NFSv3 read data transfers per second. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `read_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `total.read_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `total.read_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `total.read_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `nfsv3_read_throughput`
Unit: b_per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `nfs4_read_throughput`
Unit: b_per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -12867,6 +13282,17 @@ Rate of NFSv3 data transfers per second. | ZAPI | `perf-object-get-instances nfsv4_2` | `nfs42_throughput`
Unit: b_per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.11.0/nfsv4_2.yaml | +### svm_nfs_total_throughput + +Performance metric aggregated over all types of I/O operations. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | + + ### svm_nfs_verify_avg_latency Average latency of VERIFY procedures @@ -12926,8 +13352,11 @@ Average latency of Write procedure requests. The counter keeps track of the aver | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `write.average_latency`
Unit: microsec
Type: average
Base: write.total | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `write.average_latency`
Unit: microsec
Type: average
Base: write.total | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `write.average_latency`
Unit: microsec
Type: average
Base: write.total | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `write.average_latency`
Unit: microsec
Type: average
Base: write.total | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `write_avg_latency`
Unit: microsec
Type: average,no-zero-values
Base: write_total | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `write_avg_latency`
Unit: microsec
Type: average,no-zero-values
Base: write_total | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -12942,6 +13371,9 @@ Total observed NFSv3 write operations per second. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `nfsv3_write_ops`
Unit: per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | @@ -12952,8 +13384,11 @@ Rate of NFSv3 write data transfers per second. | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/svm_nfs_v3` | `write_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv3.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v3.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv3.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v4` | `total.write_throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v4.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v41` | `total.throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_1.yaml | +| KeyPerf | `api/protocols/nfs/services` | `statistics.v41.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/nfsv4_1.yaml | | REST | `api/cluster/counter/tables/svm_nfs_v42` | `total.throughput`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/nfsv4_2.yaml | | ZAPI | `perf-object-get-instances nfsv3` | `nfsv3_write_throughput`
Unit: b_per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv3.yaml | | ZAPI | `perf-object-get-instances nfsv4` | `nfs4_write_throughput`
Unit: b_per_sec
Type: rate,no-zero-values
Base: | conf/zapiperf/cdot/9.8.0/nfsv4.yaml | @@ -14357,6 +14792,114 @@ Number of write operations per second to the volume | ZAPI | `perf-object-get-instances volume:vserver` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume_svm.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`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_other_latency + +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_latency is [volume_other_latency](#volume_other_latency) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_other_ops + +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_ops is [volume_other_ops](#volume_other_ops) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_read_data + +Performance metric for read I/O operations. svm_volume_read_data is [volume_read_data](#volume_read_data) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_read_latency + +Performance metric for read I/O operations. svm_volume_read_latency is [volume_read_latency](#volume_read_latency) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_read_ops + +Performance metric for read I/O operations. svm_volume_read_ops is [volume_read_ops](#volume_read_ops) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### svm_volume_total_data + +Performance metric aggregated over all types of I/O operations. svm_volume_total_data is [volume_total_data](#volume_total_data) aggregated by `svm`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | 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`
Unit:
Type:
Base: | 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`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### 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`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### 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`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + +### 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`. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + ### svm_vscan_connections_active Total number of current active connections @@ -14858,6 +15401,15 @@ Number of NFS write operations per second to the volume | REST | `api/private/cli/volume/efficiency/stat` | `num_compress_fail` | conf/rest/9.14.0/volume.yaml | +### 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. + +| API | Endpoint | Metric | Template | +|--------|----------|--------|---------| +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + ### volume_other_latency Average latency in microseconds for the WAFL filesystem to process other operations to the volume; not including request processing or network communication time @@ -14865,6 +15417,7 @@ Average latency in microseconds for the WAFL filesystem to process other operati | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `other_latency`
Unit: microsec
Type: average
Base: total_other_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `other_latency`
Unit: microsec
Type: average
Base: other_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -14875,6 +15428,7 @@ Number of other operations per second to the volume | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_other_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.other`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `other_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -14935,6 +15489,7 @@ Bytes read per second | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `bytes_read`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -14945,6 +15500,7 @@ Average latency in microseconds for the WAFL filesystem to process read request | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `read_latency`
Unit: microsec
Type: average
Base: total_read_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_latency`
Unit: microsec
Type: average
Base: read_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -14955,6 +15511,7 @@ Number of read operations per second from the volume | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_read_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.read`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `read_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -15291,9 +15848,19 @@ This metric represents the total amount of data that has been read from and writ | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `bytes_read, bytes_written`
Unit:
Type:
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `volume` | `read_data, write_data`
Unit:
Type:
Base: | 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`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | + + ### volume_total_ops Number of operations per second serviced by the volume @@ -15301,6 +15868,7 @@ Number of operations per second serviced by the volume | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.total`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `total_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -15311,6 +15879,7 @@ Bytes written per second | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `bytes_written`
Unit: b_per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.throughput_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_data`
Unit: b_per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -15321,6 +15890,7 @@ Average latency in microseconds for the WAFL filesystem to process write request | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `write_latency`
Unit: microsec
Type: average
Base: total_write_ops | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.latency_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_latency`
Unit: microsec
Type: average
Base: write_ops | conf/zapiperf/cdot/9.8.0/volume.yaml | @@ -15331,6 +15901,7 @@ Number of write operations per second to the volume | API | Endpoint | Metric | Template | |--------|----------|--------|---------| | REST | `api/cluster/counter/tables/volume` | `total_write_ops`
Unit: per_sec
Type: rate
Base: | conf/restperf/9.12.0/volume.yaml | +| KeyPerf | `api/storage/volumes` | `statistics.iops_raw.write`
Unit:
Type:
Base: | conf/keyperf/9.15.0/volume.yaml | | ZAPI | `perf-object-get-instances volume` | `write_ops`
Unit: per_sec
Type: rate
Base: | conf/zapiperf/cdot/9.8.0/volume.yaml | From 9e969fcb9e740045d97b6986e80493b7bfbdba49 Mon Sep 17 00:00:00 2001 From: rahulguptajss Date: Wed, 30 Oct 2024 17:06:13 +0530 Subject: [PATCH 2/2] feat: add keyperf metric docs --- conf/keyperf/default.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/conf/keyperf/default.yaml b/conf/keyperf/default.yaml index ae67d1e4b..522eea2b9 100644 --- a/conf/keyperf/default.yaml +++ b/conf/keyperf/default.yaml @@ -10,8 +10,6 @@ objects: CIFSvserver: cifs_vserver.yaml Cluster: cluster.yaml LIF: lif.yaml - Lun: lun.yaml - Namespace: namespace.yaml NFSv3: nfsv3.yaml NFSv41: nfsv4_1.yaml NFSv4: nfsv4.yaml