doc: add unit to workload and metadata counters

NetApp · Apr 27, 2023 · 233abab · 233abab
1 parent 30fc144
commit 233abab
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 30 deletions.
diff --git a/cmd/tools/generate/counter.yaml b/cmd/tools/generate/counter.yaml
@@ -248,10 +248,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_collector_instances
     Description: number of objects collected from monitored cluster
@@ -260,10 +262,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
 
   - Name: metadata_collector_metrics
     Description: number of counters collected from monitored cluster
@@ -272,10 +276,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
 
   - Name: metadata_collector_parse_time
     Description: amount of time to parse XML, JSON, etc. for cluster object
@@ -284,10 +290,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_collector_plugin_time
     Description: amount of time for all plugins to post-process metrics
@@ -296,10 +304,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_collector_poll_time
     Description: amount of time it took for the poll to finish
@@ -308,10 +318,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_collector_task_time
     Description: amount of time it took for each collector's subtasks to complete
@@ -320,10 +332,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_component_count
     Description: number of metrics collected for each object
@@ -332,10 +346,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
 
   - Name: metadata_component_status
     Description: status of the collector - 0 means running, 1 means standby, 2 means
@@ -345,10 +361,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: enum
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: enum
 
   - Name: metadata_exporter_count
     Description: number of metrics and labels exported
@@ -357,10 +375,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
 
   - Name: metadata_exporter_time
     Description: amount of time it took to render, export, and serve exported data
@@ -369,10 +389,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: microseconds
 
   - Name: metadata_target_goroutines
     Description: number of goroutines that exist within the poller
@@ -381,10 +403,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: scalar
 
   - Name: metadata_target_status
     Description: status of the system being monitored. 0 means reachable, 1 means unreachable
@@ -393,10 +417,12 @@ counters:
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: enum
       - API: ZAPI
         Endpoint: NA
         ONTAPCounter: Harvest generated
         Template: NA
+        Unit: enum
 
   - Name: node_cpu_busytime
     Description: The time (in hundredths of a second) that the CPU has been doing useful
@@ -414,10 +440,12 @@ counters:
         Endpoint: api/cluster/counter/tables/qos_detail
         ONTAPCounter: Harvest generated
         Template: conf/restperf/9.12.0/workload_detail.yaml
+        Unit: microseconds
       - API: ZAPI
         Endpoint: perf-object-get-instances workload_detail
         ONTAPCounter: Harvest generated
         Template: conf/zapiperf/9.12.0/workload_detail.yaml
+        Unit: microseconds
 
   - Name: qos_detail_volume_resource_latency
     Description: average latency for volume on Data ONTAP subsystems
@@ -426,10 +454,12 @@ counters:
         Endpoint: api/cluster/counter/tables/qos_detail_volume
         ONTAPCounter: Harvest generated
         Template: conf/restperf/9.12.0/workload_detail_volume.yaml
+        Unit: microseconds
       - API: ZAPI
         Endpoint: perf-object-get-instances workload_detail_volume
         ONTAPCounter: Harvest generated
         Template: conf/zapiperf/9.12.0/workload_detail_volume.yaml
+        Unit: microseconds
 
   - Name: quota_disk_limit
     Description: Maximum amount of disk space, in kilobytes, allowed for the quota target

diff --git a/docs/ontap-metrics.md b/docs/ontap-metrics.md
@@ -2608,8 +2608,8 @@ amount of time to collect data from monitored cluster object
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_collector_instances
@@ -2618,8 +2618,8 @@ number of objects collected from monitored cluster
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
 
 
 ### metadata_collector_metrics
@@ -2628,8 +2628,8 @@ number of counters collected from monitored cluster
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
 
 
 ### metadata_collector_parse_time
@@ -2638,8 +2638,8 @@ amount of time to parse XML, JSON, etc. for cluster object
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_collector_plugin_time
@@ -2648,8 +2648,8 @@ amount of time for all plugins to post-process metrics
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_collector_poll_time
@@ -2658,8 +2658,8 @@ amount of time it took for the poll to finish
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_collector_task_time
@@ -2668,8 +2668,8 @@ amount of time it took for each collector's subtasks to complete
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_component_count
@@ -2678,8 +2678,8 @@ number of metrics collected for each object
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
 
 
 ### metadata_component_status
@@ -2688,8 +2688,8 @@ status of the collector - 0 means running, 1 means standby, 2 means failed
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> enum | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> enum | NA | 
 
 
 ### metadata_exporter_count
@@ -2698,8 +2698,8 @@ number of metrics and labels exported
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
 
 
 ### metadata_exporter_time
@@ -2708,8 +2708,8 @@ amount of time it took to render, export, and serve exported data
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> microseconds | NA | 
 
 
 ### metadata_target_goroutines
@@ -2718,8 +2718,8 @@ number of goroutines that exist within the poller
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> scalar | NA | 
 
 
 ### metadata_target_status
@@ -2728,8 +2728,8 @@ status of the system being monitored. 0 means reachable, 1 means unreachable
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `NA` | `Harvest generated` | NA |
-| ZAPI | `NA` | `Harvest generated` | NA |
+| REST | `NA` | `Harvest generated`<br><span class="key">Unit:</span> enum | NA | 
+| ZAPI | `NA` | `Harvest generated`<br><span class="key">Unit:</span> enum | NA | 
 
 
 ### namespace_avg_other_latency
@@ -6889,8 +6889,8 @@ average latency for workload on Data ONTAP subsystems
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/cluster/counter/tables/qos_detail` | `Harvest generated`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/restperf/9.12.0/workload_detail.yaml | 
-| ZAPI | `perf-object-get-instances workload_detail` | `Harvest generated`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/zapiperf/9.12.0/workload_detail.yaml | 
+| REST | `api/cluster/counter/tables/qos_detail` | `Harvest generated`<br><span class="key">Unit:</span> microseconds<br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/restperf/9.12.0/workload_detail.yaml | 
+| ZAPI | `perf-object-get-instances workload_detail` | `Harvest generated`<br><span class="key">Unit:</span> microseconds<br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/zapiperf/9.12.0/workload_detail.yaml | 
 
 
 ### qos_detail_volume_resource_latency
@@ -6899,8 +6899,8 @@ average latency for volume on Data ONTAP subsystems
 
 | API    | Endpoint | Metric | Template |
 |--------|----------|--------|---------|
-| REST | `api/cluster/counter/tables/qos_detail_volume` | `Harvest generated`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/restperf/9.12.0/workload_detail_volume.yaml | 
-| ZAPI | `perf-object-get-instances workload_detail_volume` | `Harvest generated`<br><span class="key">Unit:</span> <br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/zapiperf/9.12.0/workload_detail_volume.yaml | 
+| REST | `api/cluster/counter/tables/qos_detail_volume` | `Harvest generated`<br><span class="key">Unit:</span> microseconds<br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/restperf/9.12.0/workload_detail_volume.yaml | 
+| ZAPI | `perf-object-get-instances workload_detail_volume` | `Harvest generated`<br><span class="key">Unit:</span> microseconds<br><span class="key">Type:</span> <br><span class="key">Base:</span>  | conf/zapiperf/9.12.0/workload_detail_volume.yaml | 
 
 
 ### qos_latency