Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add unit to workload and metadata counters #2013

Merged
merged 1 commit into from
Apr 27, 2023
Merged

doc: add unit to workload and metadata counters #2013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions cmd/tools/generate/counter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
60 changes: 30 additions & 30 deletions docs/ontap-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down