Question

API Metrics explained

  • 2 March 2020
  • 7 replies
  • 1986 views

Badge

Hi All,

I am pulling some data with the API.

For example https://MYIP:9440/PrismGateway/services/rest/v2.0/hosts

Results with , among other metrics, the following.

Where can I find an explanation of each metric?

[This is just an example, I would like as many fields explained]

            "stats": {
                "hypervisor_avg_io_latency_usecs": "0",
                "num_read_iops": "319",
                "hypervisor_write_io_bandwidth_kBps": "0",
                "timespan_usecs": "20000000",
                "controller_num_read_iops": "696",
                "read_io_ppm": "641128",
                "controller_num_iops": "1588",
                "total_read_io_time_usecs": "-1",
                "controller_total_read_io_time_usecs": "196391465",
                "hypervisor_num_io": "0",
                "controller_total_transformed_usage_bytes": "-1",
                "hypervisor_cpu_usage_ppm": "60000",
                "controller_num_write_io": "17846",
                "avg_read_io_latency_usecs": "-1",
                "content_cache_logical_ssd_usage_bytes": "0",
                "controller_total_io_time_usecs": "1047534860",
                "controller_total_read_io_size_kbytes": "1001929",
                "controller_num_seq_io": "-1",
                "controller_read_io_ppm": "438363",
                "content_cache_num_lookups": "239917",
                "controller_total_io_size_kbytes": "2031200",
                "content_cache_hit_ppm": "523118",
                "controller_num_io": "31775",
                "hypervisor_avg_read_io_latency_usecs": "0",
                "content_cache_num_dedup_ref_count_pph": "100",
                "num_write_iops": "178",
                "controller_num_random_io": "0",
                "num_iops": "497",
                "hypervisor_num_read_io": "0",
                "hypervisor_total_read_io_time_usecs": "0",
                "controller_avg_io_latency_usecs": "32967",
                "num_io": "9959",
                "controller_num_read_io": "13929",
                "hypervisor_num_write_io": "0",
                "controller_seq_io_ppm": "-1",
                "controller_read_io_bandwidth_kBps": "50096",
                "controller_io_bandwidth_kBps": "101560",
                "hypervisor_num_received_bytes": "0",
                "hypervisor_timespan_usecs": "60000000",
                "hypervisor_num_write_iops": "0",
                "total_read_io_size_kbytes": "473896",
                "hypervisor_total_io_size_kbytes": "0",
                "avg_io_latency_usecs": "1749",
                "hypervisor_num_read_iops": "0",
                "content_cache_saved_ssd_usage_bytes": "0",
                "controller_write_io_bandwidth_kBps": "51463",
                "controller_write_io_ppm": "561636",
                "hypervisor_avg_write_io_latency_usecs": "0",
                "hypervisor_num_transmitted_bytes": "0",
                "hypervisor_total_read_io_size_kbytes": "0",
                "read_io_bandwidth_kBps": "23694",
                "hypervisor_memory_usage_ppm": "247304",
                "hypervisor_num_iops": "0",
                "hypervisor_io_bandwidth_kBps": "0",
                "controller_num_write_iops": "892",
                "total_io_time_usecs": "17425915",
                "content_cache_physical_ssd_usage_bytes": "0",
                "controller_random_io_ppm": "-1",
                "controller_avg_read_io_size_kbytes": "71",
                "total_transformed_usage_bytes": "-1",
                "avg_write_io_latency_usecs": "-1",
                "num_read_io": "6385",
                "write_io_bandwidth_kBps": "31376",
                "hypervisor_read_io_bandwidth_kBps": "0",
                "random_io_ppm": "-1",
                "total_untransformed_usage_bytes": "-1",
                "hypervisor_total_io_time_usecs": "0",
                "num_random_io": "-1",
                "controller_avg_write_io_size_kbytes": "57",
                "controller_avg_read_io_latency_usecs": "14099",
                "num_write_io": "3574",
                "total_io_size_kbytes": "1101416",
                "io_bandwidth_kBps": "55070",
                "content_cache_physical_memory_usage_bytes": "16144387132",
                "controller_timespan_usecs": "20000000",
                "num_seq_io": "-1",
                "content_cache_saved_memory_usage_bytes": "0",
                "seq_io_ppm": "-1",
                "write_io_ppm": "358871",
                "controller_avg_write_io_latency_usecs": "47693",
                "content_cache_logical_memory_usage_bytes": "16144387132"
            },

 

Thanks


7 replies

Badge

Some details can be found here https://portal.nutanix.com/#/page/docs/details?targetId=Prism-Central-Guide-Prism-v5_16:mul-performance-management-pc-c.html

Badge

Hi @Siddhalingesh 

Thanks for the reply.

But I cannot find any of the metrics mentioned above in your linked knowledge article.

Cheers!

Userlevel 3
Badge +4

Hi @Siddhalingesh 

Thanks for the reply.

But I cannot find any of the metrics mentioned above in your linked knowledge article.

Cheers!

@Sammy777 just offhand I looked for one at random and found it:
 

Content Cache SSD Usage Saved SSD usage (in bytes) saved due to content cache deduplication.

ID: CONTENT_CACHE_SAVED_SSD_USAGE_BYTES

 

What specifically are you looking for and not finding? 

Badge

Hi @Siddhalingesh 

Thanks for the reply.

But I cannot find any of the metrics mentioned above in your linked knowledge article.

Cheers!

@Sammy777 just offhand I looked for one at random and found it:
 

Content Cache SSD Usage Saved SSD usage (in bytes) saved due to content cache deduplication.

ID: CONTENT_CACHE_SAVED_SSD_USAGE_BYTES

 

What specifically are you looking for and not finding? 

 

@JeremyJ 

You were lucky :)

I searched randomly for a few metrics.

Couldn’t find the following

  • hypervisor_avg_io_latency_usecs
  • timespan_usecs
  • hypervisor_cpu_usage_ppm
  • hypervisor_memory_usage_ppm
  • etc. etc.

The question is also a generic one.

Where can I find an explanation for all metrics and for all API calls?

 

Cheers!

Userlevel 3
Badge +4

Re: Where can I find an explanation for all metrics and for all API calls?

What's available is posted at https://www.nutanix.dev/

It's not as exhaustive as I wish it was. 

Badge

Re: Where can I find an explanation for all metrics and for all API calls?

What's available is posted at https://www.nutanix.dev/

It's not as exhaustive as I wish it was. 

Thank you @JeremyJ 

But I cannot find most of the fields retrieved by API calls.

I think the documentation is missing more info than there is or should be.

Userlevel 3
Badge +4

If you bring it up with your Nutanix SE or account team, preferably noting specific deficiencies and the business use-case for adding to the documentation, they could raise it as a formal request.

Reply