Skip to content

Commit

Permalink
doc: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hardikl committed Nov 25, 2024
1 parent afbe4fa commit d03784f
Showing 1 changed file with 50 additions and 5 deletions.
55 changes: 50 additions & 5 deletions docs/ontap-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ These can be generated on demand by running `bin/harvest grafana metrics`. See
- More information about ONTAP REST performance counters can be found [here](https://docs.netapp.com/us-en/ontap-pcmap-9121/index.html).

```
Creation Date : 2024-Nov-22
Creation Date : 2024-Nov-25
ONTAP Version: 9.15.1
```
## Understanding the structure
Expand Down Expand Up @@ -1150,6 +1150,33 @@ Performance metric for read I/O operations.
| KeyPerf | `api/cluster` | `statistics.iops_raw.read`<br><span class="key">Unit:</span> per_sec<br><span class="key">Type:</span> rate<br><span class="key">Base:</span> | conf/keyperf/9.15.0/cluster.yaml |


### cluster_software_status

Displays the software job with its status.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `NA` | `Harvest generated` | conf/rest/9.6.0/clustersoftware.yaml |


### cluster_software_update

Displays the software update phase with its status.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `NA` | `Harvest generated` | conf/rest/9.6.0/clustersoftware.yaml |


### cluster_software_validation

Displays the software pre-validation checks with their status.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `NA` | `Harvest generated` | conf/rest/9.6.0/clustersoftware.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.
Expand Down Expand Up @@ -1180,6 +1207,15 @@ 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_tags

Displays tags at the cluster level.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `NA` | `Harvest generated` | conf/rest/9.12.0/status.yaml |


### cluster_total_data

Performance metric aggregated over all types of I/O operations.
Expand Down Expand Up @@ -2898,7 +2934,7 @@ Percentage of blocks overwritten to write-cache among all disk writes.

### flexcache_blocks_requested_from_client

Total blocks requested by the client.


| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand All @@ -2908,7 +2944,7 @@ Total blocks requested by the client.

### flexcache_blocks_retrieved_from_origin

Blocks retrieved from origin in case of a cache miss. This can be divided by the raw client_requested_blocks and multiplied by 100 to calculate the cache miss percentage.


| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -3054,7 +3090,7 @@ Total number of reconciled lock entries at cache side.

### flexcache_size

Physical size of the volume, in bytes. The minimum size for a FlexVol volume is 20MB and the minimum size for a FlexGroup volume is 200MB per constituent. The recommended size for a FlexGroup volume is a minimum of 100GB per constituent. For all volumes, the default size is equal to the minimum size.
Physical size of the FlexCache. The recommended size for a FlexCache is 10% of the origin volume. The minimum FlexCache constituent size is 1GB.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
Expand Down Expand Up @@ -4902,7 +4938,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`<br><span class="key">Unit:</span> percent<br><span class="key">Type:</span> percent<br><span class="key">Base:</span> cpu_elapsed_time | conf/restperf/9.12.0/system_node.yaml |
| KeyPerf | `api/cluster/nodes` | `statistics.processor_utilization_raw`<br><span class="key">Unit:</span> statistics.processor_utilization_base<br><span class="key">Type:</span> percent<br><span class="key">Base:</span> | conf/keyperf/9.15.0/node.yaml |
| KeyPerf | `api/cluster/nodes` | `statistics.processor_utilization_raw`<br><span class="key">Unit:</span> statistics.processor_utilization_base<br><span class="key">Type:</span> percent<br><span class="key">Base:</span> | conf/keyperf/9.15.0/system_node.yaml |
| ZAPI | `perf-object-get-instances system:node` | `avg_processor_busy`<br><span class="key">Unit:</span> percent<br><span class="key">Type:</span> percent<br><span class="key">Base:</span> cpu_elapsed_time | conf/zapiperf/cdot/9.8.0/system_node.yaml |


Expand Down Expand Up @@ -15819,6 +15855,15 @@ The size (in percent) that is physically used in the volume.The percentage is ba
| ZAPI | `volume-get-iter` | `volume-attributes.volume-space-attributes.physical-used-percent` | conf/zapi/cdot/9.8.0/volume.yaml |


### volume_tags

Displays tags at the volume level.

| API | Endpoint | Metric | Template |
|--------|----------|--------|---------|
| REST | `NA` | `Harvest generated` | conf/rest/9.12.0/volume.yaml |


### volume_top_clients_read_data

This metric measures the amount of data read by the top clients to a specific volume.
Expand Down

0 comments on commit d03784f

Please sign in to comment.