Entities, lookup information, metrics, and API calls for Nutanix - Prism API Extractor

This topic explains the predefined metrics that are available from Nutanix and how they are mapped to the BMC Helix Capacity Optimization metrics.

Entity list

The Nutanix - Prism API Extractor collects metrics of the following entities:

  • Cluster
  • Host
  • Virtual Machine
  • Storage Pool

Lookup information

The following table lists the sequence of field sets for strong lookup and weak lookup.

Entity

BMC Helix Capacity Optimization Entity name

Entity typeStrong lookup fields
ClusterCluster - Acropolisvhc:ahvUUID
HostHost - Acropolisvh:ahvUUID
VMVirtual Machine - Acropolisgm:ahvUUID
Storage PoolStorage Pool - Acropolissp:ahvUUID

Metric mapping

The following tables contain the mapping between the Nutanix metrics and the BMC Helix Capacity Optimization metrics.

Configuration metrics for Cluster

BMC Helix Capacity Optimization metric

Nutanix API field
TIMEZONEtimezone
HOST_NUMnum_nodes
NET_IP_ADDRESScluster_external_ipaddress
CLUSTER_NAMEname
DISK_NUMdisks(count)
GM_NUMvms(count)
CLUSTER_NAMECluster Name
TOTAL_REAL_MEM

SUM of underlying hosts

memory_capacity_in_bytes

Configuration metrics for Host 

BMC Helix Capacity Optimization metric

Nutanix API field
CLUSTER_IDcluster_uuid
CPU_TOTAL_MHZcpu_capacity_in_hz
CPU_MHZcpu_frequency_in_hz
CPU_MODELcpu_model
BYDISK_SIZEdisk.disk_size
DISK_NUMdisks(count)
NET_IP_ADDRESShypervisor_address
TOTAL_REAL_MEMmemory_capacity_in_bytes
CPU_CORES_PER_SOCKETnum_cpu_cores/num_cpu_sockets
CPU_THREADS_PER_COREnum_cpu_threads/num_cpu_cores
GM_NUMnum_vms
SERIAL_NUMBERserial

Configuration metrics for Virtual Machine

BMC Helix Capacity Optimization metric

Nutanix API field

VM_LAST_STATUSpowerState
HOST_IDhostUuid
CLUSTER_IDclusterUuid
TOTAL_REAL_MEMmemoryCapacityInBytes
CPU_NUMnumVCpus
NETIF_NUMnumNetworkAdapters

NET_IP_ADDRESS/

NET_IP_ADDRESSES

ipAddresses

Configuration metrics for Storage Pool

BMC Helix Capacity Optimization metric

Nutanix API field

CLUSTER_ID
clusterUuid
DISK_NUMdisks (count)

Performance metrics

Performance metrics for Cluster

BMC Helix Capacity Optimization metric

Nutanix metric

FormulaDescription
CPU_UTILhypervisor_cpu_usage_ppmhypervisor_cpu_usage_ppm/1000000Percentage of time the CPU was not idle during the interval
MEM_UTILhypervisor_memory_usage_ppmhypervisor_memory_usage_ppm/1000000Percentage of physical memory in use during the interval
DISK_TOTAL_LATENCYavg_io_latency_usecsavg_io_latency_usecs/1000The disk total latency.
DISK_IO_RATEnum_iops
Disk Average I/O Rate aggregated by host
DISK_IO_READ_RATEnum_read_iops
Disk Average I/O Read Rate aggregated by host
DISK_IO_WRITE_RATEnum_write_iops
Disk Average I/O Write Rate aggregated by host
DISK_TRANSFER_RATEtotal_io_size_kbytes(total_io_size_kbytes*1024)/3600The average number of bytes per second at which data was transferred.
DISK_READ_RATEtotal_read_io_size_kbytes(total_read_io_size_kbytes*1024)/3600The average Bytes per second read from disk device during the interval.
DISK_WRITE_RATE

total_io_size_kbytes

total_read_io_size_kbytes

(total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600The average Bytes per second write to disk device during the interval.
TOTAL_DSTORE_SIZEstorage.capacity_bytes
The sum of the size of the datastores used by this system in bytes.
TOTAL_DSTORE_FREEstorage.free_bytes
The sum of the free space of all the datastores used by this system in bytes.
TOTAL_DSTORE_USEDstorage.usage_bytes
Total physical datastore space used by this machine and all its snapshots on the datastores.
TOTAL_DSTORE_UTIL

storage.usage_bytes

storage.capacity_bytes

storage.usage_bytes/storage.capacity_bytesTotal physical storage space utilization % on this system.

Performance metrics for Host

BMC Helix Capacity Optimization metric

Nutanix metricFormulaDescription
CPU_UTILhypervisor_cpu_usage_ppmhypervisor_cpu_usage_ppm/1000000Percentage of time the CPU was not idle during the interval.
MEM_UTILhypervisor_memory_usage_ppmhypervisor_memory_usage_ppm/1000000Percentage of physical memory in use during the interval.
DISK_TOTAL_LATENCY

avg_io_latency_usecs

avg_io_latency_usecs/1000The disk total latency
DISK_IO_RATEnum_iops
Disk Average I/O Rate aggregated by host
DISK_IO_READ_RATEnum_read_iops
Disk Average I/O Read Rate aggregated by host
DISK_IO_WRITE_RATEnum_write_iops
Disk Average I/O Write Rate aggregated by host
DISK_TRANSFER_RATEtotal_io_size_kbytes(total_io_size_kbytes*1024)/3600The average number of bytes per second at which data was transferred
DISK_READ_RATEtotal_read_io_size_kbytestotal_read_io_size_kbytes*1024)/3600The average Bytes per second read from disk device during the interval
DISK_WRITE_RATE

total_io_size_kbytes

total_read_io_size_kbytes

(total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600The average Bytes per second write to disk device during the interval
TOTAL_DSTORE_SIZEstorage.capacity_bytes
The sum of the size of the datastores used by this system in bytes.
TOTAL_DSTORE_FREE
storage.free_bytes
The sum of the free space of all the datastores used by this system in bytes.
TOTAL_DSTORE_USEDstorage.usage_bytes
Total physical datastore space used by this machine and all its snapshots on the datastores.
TOTAL_DSTORE_UTIL

storage.usage_bytes

storage.capacity_bytes

storage.usage_bytes/storage.capacity_bytesTotal physical storage space utilization % on this cloud system.

Performance metrics for Virtual Machine

BMC Helix Capacity Optimization metric

Nutanix metricFormulaDescription
CPU_UTILhypervisor_cpu_usage_ppmhypervisor_cpu_usage_ppm/1000000Percentage of time the CPU was not idle during the interval.
CPU_READYhypervisor.cpu_ready_time_ppmhypervisor.cpu_ready_time_ppm/1000000Percentage of time the CPU was in Ready state during the interval
DISK_TOTAL_LATENCYcontroller_avg_io_latency_usecscontroller_avg_io_latency_usecs/1000The disk total latency
DISK_IO_READ_RATEcontroller_num_read_iops
Disk Average I/O Read Rate aggregated by host
DISK_IO_WRITE_RATEcontroller_num_write_iops
Disk Average I/O Write Rate aggregated by host
DISK_IO_RATEcontroller_num_iops
Disk Average I/O Rate aggregated by host
DISK_TRANSFER_RATEcontroller_total_io_size_kbytescontroller_total_io_size_kbytes*1024/3600
The average number of bytes per second at which data was transferred
DISK_READ_RATEcontroller_total_read_io_size_kbytescontroller_total_read_io_size_kbytes*1024/3600The average Bytes per second read from disk device during the interval
DISK_WRITE_RATE

controller_total_io_size_kbytes

controller_total_read_io_size_kbytes

(controller_total_io_size_kbytes-controller_total_read_io_size_kbytes)*1024/3600The average Bytes per second write to disk device during the interval
MEM_UTILguest.memory_usage_ppmguest.memory_usage_ppm/1000000Percentage of physical memory in use during the interval.
MEM_USED

guest.memory_usage_ppm

TOTAL_REAL_MEM

(guest.memory_usage_ppm/1000000) * TOTAL_REAL_MEMThe total used memory, in bytes
MEM_FREE

guest.memory_usage_ppm

TOTAL_REAL_MEM

TOTAL_REAL_MEM - ((guest.memory_usage_ppm/1000000) * TOTAL_REAL_MEM)The total free memory, in bytes
NET_IN_BIT_RATEhypervisor_num_received_byteshypervisor_num_received_bytes/3600Average Bit/s received
NET_OUT_BIT_RATEhypervisor_num_transmitted_byteshypervisor_num_transmitted_bytes/3600Average Bit/s sent
NET_BIT_RATE

hypervisor_num_received_bytes

hypervisor_num_transmitted_bytes

(hypervisor_num_received_bytes+hypervisor_num_transmitted_bytes)/3600Average Bit/s sent and received

Performance metrics for Storage Pool

BMC Helix Capacity Optimization metric

Nutanix metricFormulaDescription
DISK_TOTAL_LATENCYavg_io_latency_usecsavg_io_latency_usecs/1000
DISK_IO_RATEnum_iops
Disk Average I/O Rate aggregated by host.
DISK_IO_READ_RATEnum_read_iops
Disk Average I/O Read Rate aggregated by host
DISK_IO_WRITE_RATEnum_write_iops
Disk Average I/O Write Rate aggregated by host
DISK_TRANSFER_RATEtotal_io_size_kbytes(total_io_size_kbytes*1024)/3600The average number of bytes per second at which data was transferred
DISK_READ_RATEtotal_read_io_size_kbytes(total_read_io_size_kbytes*1024)/3600The average Bytes per second read from disk device during the interval
DISK_WRITE_RATE

total_io_size_kbytes

total_read_io_size_kbytes

(total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600The average Bytes per second write to disk device during the interval
TOTAL_DSTORE_SIZEstorage.capacity_bytes
The sum of the size of the datastores used by this system in bytes.
TOTAL_DSTORE_FREE
storage.free_bytes
The sum of the free space of all the datastores used by this system in bytes.
TOTAL_DSTORE_USEDstorage.usage_bytes
Total physical datastore space used by this machine and all its snapshots on the datastores.
TOTAL_DSTORE_UTIL

storage.usage_bytes

storage.capacity_bytes

storage.usage_bytes/storage.capacity_bytesTotal physical storage space utilization % on this cloud system.

API calls for Nutanix - Prism API Extractor

The extractor makes the following REST API calls on the Nutanix Acropolis Hypervisor (AHV):

TaskService Management API call
Get cluster listGET https://<prism_host>:<prism_port>/api/nutanix/v3/clusters/list
Get clustersGET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/clusters
Get cluster statsGET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/clusters/<cluster_id>/stats?metrics=%s&start_time_in_usecs=%s&end_time_in_usecs=%s&interval_in_secs=%s
Get hostsGET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/hosts
Get host stats

GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/hosts/<host_id>/stats?metrics=%s&start_time_in_usecs=%s&end_time_in_usecs=%s&interval_in_secs=%s

Get virtual machinesGET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/vms
Get virtual machine stats

GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/vms/<vm_id>/stats?metrics=%s&startTimeInUsecs=%s&endTimeInUsecs=%s&intervalInSecs=%s

Get disks

GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/disks

Get storage pools

GET https://<prism_host>:<prism_port>PrismGateway/services/rest/v1/storage_pools

Get storage pool stats

GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/storage_pools/<storage_pool_id>/stats?metrics=%s&startTimeInUsecs=%s&endTimeInUsecs=%s&intervalInSecs=%s



Was this page helpful? Yes No Submitting... Thank you

Comments