This document supports the version of each product listed and
supports all subsequent versions until the document is replaced
by a new edition. To check for more recent editions of this
document, see http://www.vmware.com/support/pubs.
EN-000912-02
Page 2
VMware vCenter Adapter Installation and Configuration Guide
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2 VMware, Inc.
Page 3
Contents
VMware vCenter Adapter Installation and Configuration Guide
5
Updated Information7
Introduction to the vCenter Adapter9
1
How the Adapter Creates Resources 9
Data that the Adapter Collects
Using the VM Entity Status Resource Tag 10
Installation and Configuration Requirements 10
vCenter Adapter Resource Identification 11
9
Installing the vCenter Adapter15
2
Install the Adapter in a Standalone Installation 15
Install the Adapter in a vApp Installation 16
vCenter Adapter Folders and Files 16
Configuring the vCenter Adapter19
3
Add a Credential 19
Add an Adapter Instance 20
Reducing the Number of Collected Metrics 20
Troubleshooting the vCenter Adapter21
4
Troubleshooting a vCenter Adapter Instance 21
View Collection Information 21
Viewing System Log Files 23
Metrics for vCenter Server Components25
5
vCenter Server Metrics 25
Datacenter Metrics 28
Cluster Compute Resource Metrics 30
Resource Pool Metrics 35
Host System Metrics 37
Virtual Machine Metrics 48
Datastore Metrics 55
Capacity Planning Metrics 59
Badge Metrics 63
Metrics for vCenter Operations Manager Components65
6
Analytics Metrics 65
Collector Metrics 70
ActiveMQ Service Metrics 71
VMware, Inc. 3
Page 4
VMware vCenter Adapter Installation and Configuration Guide
Web Server Metrics 72
Replication Server Metrics
74
Database Metrics 74
Host Operating System Metrics 75
Index77
4 VMware, Inc.
Page 5
VMware vCenter Adapter Installation and
Configuration Guide
The VMware vCenter Adapter Installation and Configuration Guide describes how to install and configure the
vCenter adapter for vCenter Operations Manager.
Intended Audience
This information is intended for anyone who needs to install or configure the vCenter adapter.
VMware, Inc. 5
Page 6
VMware vCenter Adapter Installation and Configuration Guide
6 VMware, Inc.
Page 7
Updated Information
The VMware
vCenter Adapter Installation and Configuration Guide is updated with each release of the product or
when necessary.
This table provides the update history of the VMware vCenter Adapter Installation and Configuration Guide.
RevisionDescription
EN-000912-02
EN-000912-01
EN-000912-00The vCenter Adapter Technical Note is now the VMware vCenter Adapter Installation and Configuration Guide.
n
Updated
page 10.
n
Added “Reducing the Number of Collected Metrics,” on page 20.
n
Added the datastore | notshared metric to “Virtual Machine Metrics,” on page 48.
n
Added Chapter 6, “Metrics for vCenter Operations Manager Components,” on page 65.
n
Changed the product name to reflect the new licensing model for the 5.6 release.
n
Added “vCenter Adapter Folders and Files,” on page 16.
n
Added information about configuring the adapter in a 5.6 or later vApp installation to Chapter 3,
“Configuring the vCenter Adapter,” on page 19.
n
Added “View Collection Information,” on page 21.
n
Added metrics to Chapter 5, “Metrics for vCenter Server Components,” on page 25
The vCenter Adapter Technical Note was the initial release of this document.
the list of compatible vSphere versions in “Installation and Configuration Requirements,” on
VMware, Inc. 7
Page 8
VMware vCenter Adapter Installation and Configuration Guide
8 VMware, Inc.
Page 9
Introduction to the vCenter Adapter1
The vCenter adapter is an embedded adapter for vCenter Operations Manager. The adapter collects metrics
from vCenter Server.
This chapter includes the following topics:
n
“How the Adapter Creates Resources,” on page 9
n
“Data that the Adapter Collects,” on page 9
n
“Using the VM Entity Status Resource Tag,” on page 10
n
“Installation and Configuration Requirements,” on page 10
n
“vCenter Adapter Resource Identification,” on page 11
How the Adapter Creates Resources
The
vCenter adapter can create resources in vCenter Operations Manager by using auto-discovery and manual
discovery.
When you enable auto-discovery for a vCenter adapter instance, the adapter discovers and creates resources
in vCenter Operations Manager after it runs a main collection query.
You can use manual discovery to restrict the resources that the vCenter adapter creates in
vCenter Operations Manager. With manual discovery, the adapter sends a request to vCenter Server to return
all available resources and you select the resources to add.
Data that the Adapter Collects
During each collection cycle, the vCenter adapter retrieves metric values, events, and relationships from
vCenter Server.
For metric values, the adapter queries for up to five of the most recent 20-second samples from vCenter Server
and calculates the average. The adapter also adds several aggregate metrics, which it calculates based on those
values.
The vCenter adapter collects metrics for the following vCenter Server objects:
n
Datacenter
n
Cluster
n
Resource Pools
n
Host
n
Virtual Machine
VMware, Inc. 9
Page 10
VMware vCenter Adapter Installation and Configuration Guide
n
Datastore
n
Folder
information about the metrics that the adapter collects for these objects, see Chapter 5, “Metrics for vCenter
For
Server Components,” on page 25.
Using the VM Entity Status Resource Tag
The vCenter adapter creates the VM Entity Status resource tag in the Custom user interface.
The VM Entity Status resource tag values are NotExisting, PoweredOff, and PoweredOn. Each resource tag
value includes the name of the vCenter Server instance, for example, PoweredOn:vCenter4-qalab.
Figure 1-1. VM Entity Status Resource Tag
You can select the PoweredOff or PoweredOn tag value to filter host system and virtual machine resources
based on their running state.
You
can select the NotExisting tag value to locate resources that no longer exist in the vCenter Server inventory
and remove them from the Custom user interface. When objects are removed from the vCenter Server
inventory, they remain available in the user interface until you remove them.
Installation and Configuration Requirements
Before you install the vCenter adapter, you must make sure that your system meets certain requirements.
VMware vSphere Compatibility
The vCenter adapter is compatible with vSphere 2.5, 3.0, 3.5, 4.0 update 2, 4.1, 5.0, and 5.1.
Credential Requirements
You must provide a vCenter Server user name and password when you create a credential for a vCenter adapter
instance.
The vCenter Server privileges assigned to this user account determine the scope of the data that the vCenter
adapter can collect and the visibility of that data in vCenter Operations Manager.
The adapter calculates metric values based on the visibility that the user account has to the vCenter Server
inventory. If certain objects are not visible, vCenter Operations Manager does not consider the values for these
objects when it calculates metrics for their container objects.
10 VMware, Inc.
Page 11
At a minimum, the user account must have Read privileges and the Read privileges must be assigned at the
Datacenter or vCenter Server level. If the Read privileges are assigned to selected ESX hosts or individual
virtual machines, vCenter Operations Manager cannot show metrics for their parent objects. For example, if
the user account has Read privileges only for an ESX host, you cannot view metrics for the parent datastore,
cluster, or datacenter of that ESX host in vCenter Operations Manager.
vCenter Adapter Resource Identification
The
vCenter adapter uses certain resource identifiers. You must specify resource identifiers when you reference
vCenter adapter resources with the vCenter Operations Manager API.
Adapter Kind
The adapter kind for the vCenter adapter is VMware Adapter and the identifier key is VMWARE.
Adapter Instance Resource Kind
The adapter instance resource kind for a vCenter adapter instance is vCenter Server and the identifier key is
VMwareAdapter Instance.
A vCenter adapter instance resource has a specific identifier key.
VMEntityNameNoVM Entity NameName of the virtual machine.
VMEntityObjectIDYesVM Entity Object IDvCenter Server object ID for
the virtual machine, for
example, vm-67.
VMEntityVCIDYesVC IDvCenter Server unique ID.
Datastore Resource Kind
The resource kind for a vCenter Sever datastore is Datastore and the identifier key is Datastore.
A Datastore resource has specific identifier keys.
Table 1-8. Datastore Resource Identifier Keys
KeyPart of UniquenessDefault Name (en)Description
VMEntityNameNoVM Entity NameName of the datastore.
VMEntityObjectIDYesVM Entity Object IDvCenter Server object ID for
the datastore, for example,
datastore-1.
VMEntityVCIDYesVC IDvCenter Server unique ID.
DataStorePathNoDatastore PathFor NFS-based datastores, a
string in the format
system-IP-address/pathto-element-in-storage-
.
system
Compute Resource Kind
The resource kind for a vCenter server compute resource is Compute Resource and the identifier key is
ComputerResource.
A Compute Resource resource has specific identifier keys.
Table 1-9. Compute Resource Identifier Keys
KeyPart of UniquenessDefault Name (en)Description
VMEntityNameNoVM Entity NameName of the resource.
VMEntityObjectIDYesVM Entity Object IDvCenter Server object ID for
the resource.
VMEntityVCIDYesVC IDvCenter Server unique ID.
storage-
World Resource Kind
The
World object is a logical container for all monitored objects. The resource kind for the World object is World
and the identifier key is World.
VMware, Inc. 13
Page 14
VMware vCenter Adapter Installation and Configuration Guide
VC ID Values
For
vCenter Server 4.0 and later, the VC ID is set to the VC UUID. For version 2.5, the VC ID is set to the vCenter
Server host name.
14 VMware, Inc.
Page 15
Installing the vCenter Adapter2
How you install the vCenter adapter depends on whether you have a standalone or vApp installation.
This chapter includes the following topics:
n
“Install the Adapter in a Standalone Installation,” on page 15
n
“Install the Adapter in a vApp Installation,” on page 16
n
“vCenter Adapter Folders and Files,” on page 16
Install the Adapter in a Standalone Installation
If
you have a standalone installation, you install the vCenter adapter by extracting the adapter installation files
from a TGZ file and running an installation utility.
Prerequisites
n
Download the adapter installation TGZ file anonymously from ftp://ftp.integrien.com/.
n
Make a note of the build number in the TGZ file name. The build number appears after the adapter name,
for example,
n
Read the release notes that are included with the TGZ file.
adaptername-buildnumber
.tgz.
Procedure
1Open the TGZ file and extract the TAR file to a temporary folder on your vCenter Operations Manager
server.
2In the temporary folder, open the TAR file and extract and run the installer for your operating system
platform.
3Log in to the Custom user interface as an administrator.
4Select Admin > Support.
5On the Info tab, find the Adapters Info pane and click the Describe icon (
The Describe icon is located at the top right of the Adapters Info pane.
6
Click Yes to start the describe process and click OK.
The Custom user interface finds the adapter files, gathers information about the abilities of the adapter,
and updates the user interface with information about the adapter. If you have remote collectors, it installs
the adapter on the remote collectors.
The describe process might take several minutes. When the describe process is finished, the adapter
appears in the Adapters Info pane. The build number is in the Adapter Version column.
VMware, Inc. 15
).
Page 16
VMware vCenter Adapter Installation and Configuration Guide
7Verify
that the build number in the Adapter Version column for the adapter matches the build number in
the TGZ file that you downloaded.
Install the Adapter in a vApp Installation
If you have a vApp installation, you install the vCenter adapter from a PAK file.
Prerequisites
n
Download the adapter installation PAK file anonymously from ftp://ftp.integrien.com.
n
Make a note of the build number in the PAK file name. The build number appears after the adapter name,
for example,
n
Read the release notes that are included with the PAK file.
Procedure
1Save the PAK file in a temporary folder.
2Log in to the Admin user interface as the admin user.
For example: https://
3On the Update tab, click Browse to locate the temporary folder and select the PAK file.
4Click Update and click OK to confirm the update.
The Admin user interface uploads the PAK file. The upload might take several minutes.
adapter
name-
buildnumber
ipaddress
.pak.
/admin/
5Read and accept the EULA and click OK.
6Click OK to confirm and start the update process.
The update might take several minutes. Status information appears on the Update tab when the update
is finished.
7Log in to the Custom user interface as an administrator.
For example: https://
ipaddress
/vcops-custom/
8Select Admin > Support.
9On the Info tab, find the Adapters Info pane and click the Describe icon (
The Describe icon is located at the top right of the Adapters Info pane.
Click Yes to start the describe process and click OK.
10
The Custom user interface finds the adapter files, gathers information about the abilities of the adapter,
and updates the user interface with information about the adapter.
The describe process might take several minutes. When the describe process is finished, the adapter
appears in the Adapters Info pane. The build number is in the Adapter Version column.
11 Verify that the build number in the Adapter Version column for the adapter matches the build number in
the PAK file that you uploaded.
vCenter Adapter Folders and Files
).
The installer places the vCenter adapter files in the
vcenter-ops
/user/plugins/inbound/vcenter_adapter3
folder.
The vcenter_adapter3 folder contains several subfolders and files.
16 VMware, Inc.
Page 17
Table 2-1. vCenter Adapter Folders and Files
FolderFileDescription
confdescribe.xml
eventlist.txt
history.txt
rmi.properties
version.txt
vm3.png
vmware.properties
open_source_license.txt
libapputils-custom.jar
axis.jar
axis-ant.jar
commons-discovery-0.2.jar
commons-logging-1.1.jar
jaxen.license
jaxen.readme
jaxrpc.jar
saaj.jar
vim.jar
vim25.jar
wbem.jar
wsdl4j-1.5.1.jar
Describes the adapter.
Lists the events for which the adapter creates change
events in vCenter Operations Manager.
Contains information about the changes
implemented in the adapter versions.
RMI properties.
Contains information about the adapter version.
VMware logo.
Main configuration file for the adapter.
Open source license file.
JAR files and other commonly used files.
Chapter 2 Installing the vCenter Adapter
VMware, Inc. 17
Page 18
VMware vCenter Adapter Installation and Configuration Guide
18 VMware, Inc.
Page 19
Configuring the vCenter Adapter3
For pre-5.6 releases, you configure the vCenter adapter by adding a credential and an adapter instance in the
Custom user interface.
For 5.6 and later releases, you add a credential and an adapter instance in the Custom user interface only if
you have a standalone installation.
If
you have a 5.6 or later vApp installation, you manage the vCenter adapter from vCenter Operations Manager
Administration. You define adapter settings for a vCenter server system in the vCenter Server Registration
pane on the Registration tab. For more information, see the vCenter Operations Manager Administration online
help.
This chapter includes the following topics:
n
“Add a Credential,” on page 19
n
“Add an Adapter Instance,” on page 20
n
“Reducing the Number of Collected Metrics,” on page 20
Add a Credential
You must use the Custom user interface to create a credential for a vCenter adapter instance if you have a 5.6
or later standalone installation or a pre-5.6 standalone or vApp installation.
You use a vCenter Server user name and password to create a credential for the adapter instance.
You can add the credential before you create the adapter instance and select the correct credential when you
define the adapter instance, or you can add the credential when you define the adapter instance.
Prerequisites
n
Install or upgrade the vCenter adapter. See Chapter 2, “Installing the vCenter Adapter,” on page 15.
n
Verify that the user name and password meet the credential requirements. See “Credential
Requirements,” on page 10.
Procedure
1Log in to the Custom user interface as an administrator.
3Select VMware Adapter from the Adapter Kind drop-down menu.
4Select Principal Credential from the Credential Kind drop-down menu.
5At the top of the list of credentials, next to Action, click Add.
6Type a unique name for the credential instance in the Instance name text box.
VMware, Inc. 19
Page 20
VMware vCenter Adapter Installation and Configuration Guide
7Type the user name and password combination in the User name and Password text boxes.
8
Click OK to add the credential for the adapter kind.
The credential appears in the list in the Manage Credentials window.
Add an Adapter Instance
You must use the Custom user interface to create an adapter instance for the vCenter adapter if you have a 5.6
or later standalone installation or a pre-5.6 standalone or vApp installation. The adapter instance defines the
adapter type and identifies the vCenter Server host.
If you have a 5.6 or later vApp installation, you manage the vCenter adapter from vCenter Operations Manager
Administration. You define adapter settings for a vCenter server system in the vCenter Server Registration
pane on the Registration tab. For more information, see the vCenter Operations Manager Administration online
help.
Prerequisites
n
Install or upgrade the vCenter adapter. See Chapter 2, “Installing the vCenter Adapter,” on page 15.
n
Create a credential, or, if you plan to create a credential when you add the adapter instance, become
familiar with creating credentials. See “Add a Credential,” on page 19.
Procedure
1Log in to the Custom user interface as an administrator.
3Select the collector to use from the Collector drop-down menu.
Unless you added additional collectors, the only available collector is vCenter Operations Server. You
can change the name of this collector when you install the standalone version.
4Select VMware Adapter from the Adapter Kind drop-down menu.
5Click the Add New Adapter Instance icon.
6Type a name for the adapter in the Adapter Instance Name text box.
7Type the IP address or host name of the vCenter Server host in the VC Host text box.
8Select true or false from the Auto Discovery drop-down menu to enable or disable auto-discovery.
If you enable auto-discovery, the data collection process discovers new resources and creates the resources
for you. If you disable auto-discovery, you must use manual discovery to create resources. Manual
discovery is useful for restricing the resources that the adapter adds. You typically enable auto-discovery
for the vCenter adapter.
9Select true or false from the Process Change Events drop-down menu to configure whether the adapter
instance processes change events.
10 Select the credential to use to sign on to the data source from the Credential drop-down menu, or click
Add to add a new credential.
11 Click OK to save your configuration.
Reducing the Number of Collected Metrics
If you have a 5.7 or later vApp installation, you can reduce the number of metrics that the vCenter adapter
collects by selecting the Balanced profile metrics profile.
You select a metrics profile option on the Registration tab in the vCenter Operations Manager Administration
user interface. For more information, see the Administration online help.
20 VMware, Inc.
Page 21
Troubleshooting the vCenter Adapter4
Known troubleshooting information can help you diagnose and correct common problems with the vCenter
adapter.
This chapter includes the following topics:
n
“Troubleshooting a vCenter Adapter Instance,” on page 21
n
“View Collection Information,” on page 21
n
“Viewing System Log Files,” on page 23
Troubleshooting a vCenter Adapter Instance
Perform
1Verify that vCenter Server is running.
2View the collection status and collection state for the adapter instance resource in Custom user interface.
3Check the adapter and collector logs for errors. See “Viewing System Log Files,” on page 23.
these general troubleshooting steps to diagnose and correct problems with a vCenter adapter instance.
See “View Collection Information,” on page 21.
View Collection Information
You can view collection information for a vCenter adapter instance in the Custom user interface. This
information can help you diagnose and troubleshoot adapter problems.
Prerequisites
Become familiar with the collection states and status values. See “Collection States,” on page 22 and
“Collection Status Values,” on page 23.
Procedure
1Log in to the Custom user interface as an administrator.
2Select Environment > Environment Overview and find the vCenter adapter instance resource on the
List tab.
3Point to the icon in the Collection State column to see whether vCenter Operations Manager should be
collecting data through the adapter instance.
The collection state appears in a pop-up window. If the adapter instance is set to collect data, the collection
state is Collecting.
4(Optional) If you have vCenter Operations Manager 5.6 or later, click the icon in the Collection State
column to see detailed information about the collection state.
VMware, Inc. 21
Page 22
VMware vCenter Adapter Installation and Configuration Guide
5Point
to the icon in the Collection Status column to see whether vCenter Operations Manager is receiving
data through the adapter instance.
The collection status and a collection status message appear in a pop-up window. If
vCenter Operations Manager is receiving data through the adapter instance, the collection status is Data
Receiving.
In vCenter Operations Manager 5.6 and later, the vCenter adapter generates a collection time status
message whenever a host system or virtual machine receives raw data from vCenter Server, for example,
Message: Last successful collection time is "Fri May 11 11:44:09 PDT 2012".
Collection States
The resource collection state indicates whether vCenter Operations Manager should be collecting data for the
resource.
The resource collection state appears in a pop-up window when you point to an icon in the Collection State
column in the resource list on the Environment Overview page. If vCenter Operations Manager collects data
for a resource through more than one adapter instance, a separate icon appears for each adapter instance.
Table 4-1. Collection States
StateDescription
CollectingResource is set to collect data.
Not CollectingResource is set to not collect data.
StartingCollection is starting.
StoppingCollection is stopping.
UpdatingResource is being updated.
FailedResource configuration problem.
In MaintenanceResource is in scheduled maintenance.
In Maintenance (Manual)Resource is in manual maintenance.
RemovingResource is being deleted.
If you click an icon in the Collection State column, detailed information appears in a pop-up window.
Table 4-2. Detailed Collection State Information
FieldDescription
Adapter InstanceName of the adapter instance.
CollectorName of the collector that the adapter instance uses.
Last HeartbeatAmount of time since vCenter Operations Manager received a heartbeat message from
the adapter. A long period of time might indicate a connection problem.
StatusStatus message from the collector.
Last Collection TimeAmount of time since the end of the last collection cycle and the number of metrics
that the adapter collected during that cycle.
Last Collection DurationLength of time of the last collection cycle.
Metric SparklinesGraphical representations of the last collection cycle duration and the number of
metrics and resources that the adapter collected during that cycle.
22 VMware, Inc.
Page 23
Chapter 4 Troubleshooting the vCenter Adapter
Collection Status Values
The
collection status value for a resource indicates whether vCenter Operations Manager is receiving data for
the resource. Collection status values appear in a pop-up window when you point to an icon in the Collection
Status column in the resource list on the Environment Overview page.
If vCenter Operations Manager collects metrics for a resource through more than one adapter instance, a
separate icon appears for each adapter instance in the Collection Status column.
A resource has a status value only if its collection state is Collecting. For information about collection states,
see “Collection States,” on page 22.
Table 4-3. Collection Status Values
StatusDescription
Data ReceivingvCenter Operations Manager is receiving data for the resource.
Old Data ReceivingData is not current. The most recent value is at least five monitoring cycles old.
No Data ReceivingAdapter instance is collecting data, but vCenter Operations Manager has not received data for the
resource.
NonevCenter Operations Manager or collection was recently started and no data has been received for
five monitoring cycles.
ErrorAn error occurred when vCenter Operations Manager attempted to collect data for the resource.
UnknownStatus of the resource is not known because the adapter instance cannot connect to the resource.
Resource DownResource is not operational.
No parent resource
monitoring
Collection downCollector or adapter instance is not operational.
Adapter instance resource is stopped.
NOTE
Some adapter instances write customized status and messages. These messages typically provide more
information about data collection problems.
Viewing System Log Files
You can view vCenter adapter errors in the adapter and collector log files in the Custom user interface. You
can view adapter and collector log files in the Custom user interface or in an external log viewer.
vCenter adapter log files are in the
are in the
The logging level is set to ERROR by default. To troubleshoot issues, set the logging level to INFO. To view
detailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG.
NOTE If you set the logging level to DEBUG, log files can become large very quickly. Set the logging level to
DEBUG only for short periods of time.
You can also package all log and configuration files in one compressed ZIP file and send the file to VMware
technical support.
For information about viewing logs files, modifying logging levels, and creating support bundles, see the
Custom user interface online help.
VMware vCenter Adapter Installation and Configuration Guide
24 VMware, Inc.
Page 25
Metrics for vCenter Server
Components5
The vCenter adapter collects metrics from vCenter Server and uses formulas to derive statistics from those
metrics.
This chapter includes the following topics:
n
“vCenter Server Metrics,” on page 25
n
“Datacenter Metrics,” on page 28
n
“Cluster Compute Resource Metrics,” on page 30
n
“Resource Pool Metrics,” on page 35
n
“Host System Metrics,” on page 37
n
“Virtual Machine Metrics,” on page 48
n
“Datastore Metrics,” on page 55
n
“Capacity Planning Metrics,” on page 59
n
“Badge Metrics,” on page 63
vCenter Server Metrics
A
vCenter adapter instance collects CPU use, disk, memory, network, and summary metrics for vCenter Server
resources.
CPU Usage Metrics
CPU usage metrics provide information about CPU use.
Table 5-1. CPU Usage Metrics
Metric KeyMetric NameDescription
cpu | capacity_usagepct_averageCapacity Usage (%)Percent capacity used.
cpu | capacity_contentionPctCPU Contention (%)Percent CPU contention.
cpu | demandPctDemand (%)Percent demand.
cpu | demandmhzDemand (MHz)Demand in megahertz.
cpu | iowaitIO Wait (ms)IO wait time in milliseconds.
cpu | numpackagesNumber of CPU SocketsNumber of CPU sockets.
cpu | capacity_contentionOverall CPU Contention (ms)Overall CPU contention in milliseconds.
cpu | capacity_provisionedProvisioned Capacity (MHz)Provisioned capacity in megahertz.
VMware, Inc. 25
Page 26
VMware vCenter Adapter Installation and Configuration Guide
Table 5-1. CPU Usage Metrics (Continued)
Metric KeyMetric NameDescription
cpu | corecount_provisionedProvisioned CPU CoresNumber of provisioned CPU cores.
cpu | reservedCapacity_averageReserved Capacity (MHz)Sum of the reservation properties of the immediate
cpu | usagemhz_averageUsage (MHz)CPU use in megahertz.
cpu | waitWait (ms)CPU time spent on the idle state.
cpu | workloadWorkload (%)Percent workload.
Disk Metrics
Disk metrics provide information about disk use.
Table 5-2. Disk Metrics
Metric KeyMetric NameDescription
children of the host's root resource pool.
disk |
commandsAveraged_average
disk | totalLatency_averageDisk Command Latency (ms)Average amount of time taken for a command from
disk | usage_averageUsage Rate (KBps)Average of the sum of the data read and written for
disk | workloadWorkload (%)Percent workload.
Commands per secondAverage number of commands issued per second
during the collection cycle.
the perspective of the guest operating system. This
metric is the sum of the Kernal Device Command
Latency and Physical Device Command Latency
metrics.
all of the disk instances of the host or virtual machine.
Memory Metrics
Memory metrics provide information about memory use and allocation.
Table 5-3. Memory Metrics
Metric KeyMetric NameDescription
mem | host_contentionPctContention (%)Percent host memory contention.
mem | host_demandMachine Demand (KB)Host memory demand in kilobytes.
mem | workloadOverall Workload (%)Percent memory workload.
mem | host_provisionedProvisioned Memory (KB)Provisioned host memory in kilobytes.
mem | reservedCapacity_averageReserved Capacity (KB)Sum of the reservation properties of the immediate
children of the host's root resource pool.
mem | host_usableUsable Memory (KB)Usable host memory in kilobytes.
mem | host_usageUsage (KB)Host memory use in kilobytes.
mem | host_usagePctUsage/Usable (%)Percent host memory used.
mem | host_contentionContention (KB)Host contention in kilobytes.
Network Metrics
Network metrics provide information about network performance.
26 VMware, Inc.
Page 27
Chapter 5 Metrics for vCenter Server Components
Table 5-4. Network Metrics
Metric KeyMetric NameDescription
net | workloadWorkload (%)Percent network workload.
net | droppedPctPackets Dropped (%)Percent network packets dropped.
net | usage_averageUsage Rate (KBps)Sum of the data transmitted and received for all of
the NIC instances of the host or virtual machine.
net | usage_capacityI/O Usage CapacityIO use capacity.
net | packetsRx_summationPackets ReceivedNumber of packets received.
net | packetsTx_summationPackets TransmittedNumber of packets transmitted.
net | droppedRx_summationReceived Packets DroppedNumber of received packets that were dropped.
net | droppedTx_summationTransmitted Packets DroppedNumber of transmitted packets that were dropped.
Summary Metrics
Summary metrics provide information about overall performance.
Table 5-5. Summary Metrics
Metric KeyMetric NameDescription
summary | capacityCapacity (%)Percent capacity.
summary | number_running_hostsNumber of Running HostsNumber of running hosts.
summary | number_running_vmsNumber of Running VMsNumber of running virtual
machines.
summary | total_number_clustersTotal Number of ClustersTotal number of clusters.
summary | total_number_datastoresTotal Number of DatastoresTotal number of datastores.
summary | total_number_hostsTotal Number of HostsTotal number of hosts.
summary | total_number_vmsTotal Number of VMsTotal number of virtual machines.
summary | total_number_datacentersTotal Number of DatacentersTotal number of datacenters.
summary |
number_powered_on_cores
summary | number_running_vcpusNumber VCPUs on Powered on VMsNumber of virtual CPUs on
summary | avg_vm_densityAverage Running VM Count per Running
summary | vcuuidVirtualCenter IDvCenter Server ID.
summary | vc_query_timeVC Query Time (ms)vCenter Server query time in
summary |
derived_metrics_comp_time
summary | number_objsNumber of objectsNumber of objects.
Number of Cores on Powered On HostsNumber of cores on powered-on
hosts.
powered-on virtual machines.
Average running virtual machine
Host
Derived Metrics Computation Time (ms)Derived metrics computation time
count per running host.
milliseconds.
in milliseconds.
Available only in 5.6 and later
releases.
Available only in 5.6 and later
releases.
VMware, Inc. 27
Page 28
VMware vCenter Adapter Installation and Configuration Guide
Table 5-5. Summary Metrics (Continued)
Metric KeyMetric NameDescription
summary | number_vc_eventsNumber of VC EventsNumber of vCenter Server events.
summary | number_sms_metricsNumber of SMS MetricsNumber of SMS metrics.
summary | collector_mem_usageCollector Memory Usage (MB)Collector memory use in
Datacenter Metrics
The vCenter adapter collects CPU usage, disk, memory, network, storage, disk space, and summary metrics
for datacenters.
CPU Usage Metrics for Datacenters
Available only in 5.6 and later
releases.
Available only in 5.6 and later
releases.
megabytes.
Available only in 5.6 and later
releases.
CPU usage metrics provide information about CPU use.
Table 5-6. CPU Usage Metrics for Datacenters
Metric KeyMetric NameDescription
cpu | capacity_usagepct_averageCapacity Usage (%)Percent capacity used.
cpu | capacity_contentionPctCPU Contention (%)Percent CPU contention.
cpu | demandPctDemand (%)Percent demand.
cpu | demandmhzDemand (MHz)Demand in megahertz.
cpu | waitIO Wait (ms)IO wait time in millliseconds.
cpu | numpackagesNumber of CPU SocketsNumber of CPU sockets.
cpu | capacity_contentionOverall CPU Contention (ms)Overall CPU contention in milliseconds.
cpu | capacity_provisionedProvisioned Capacity (MHz)Provisioned capacity in megahertz.
cpu | corecount_provisionedProvisioned CPU CoresProvisioned CPU cores.
cpu | reservedCapacity_averageReserved Capacity (MHz)Reserved capacity in megahertz.
cpu | usagemhz_averageUsage (MHz)Average use in megahertz.
cpu | iowaitWait (ms)IO wait time in milliseconds.
cpu | workloadWorkload (%)Percent workload.
Disk Metrics for Datacenters
Disk metrics provide information about disk use.
28 VMware, Inc.
Page 29
Chapter 5 Metrics for vCenter Server Components
Table 5-7. Disk Metrics for Datacenters
Metric KeyMetric NameDescription
disk | commandsAveraged_averageCommands per secondAverage number of commands issued
per second during the collection interval.
disk | totalLatency_averageDisk Command Latency (ms)Average amount of time taken for a
command from the perspective of the
guest operating system. This metric is the
sum of the Kernal Disk Command
Latency and Physical Device Command
Latency metrics.
disk | usage_averageUsage Rate (KBps)Sum of the data transmitted and received
for all the NIC instances of the host or
virtual machine.
disk | workloadWorkload (%)Percent workload.
disk | usage_capacityI/O Usage CapacityPercent IO use capacity.
Memory Metrics for Datacenters
Memory metrics provide information about memory use and allocation.
Table 5-8. Memory Metrics for Datacenters
Metric KeyMetric NameDescription
mem | host_contentionPctContention (%)Percent host contention.
mem | host_demandMachine Demand (KB)Host demand in kilobytes.
mem | workloadOverall Workload (%)Percent memory workload.
mem | host_provisionedProvisioned Memory (KB)Provisioned host memory in kilobytes.
mem | reservedCapacity_averageReserved Capacity (KB)Reserved memory capacity in kilobytes.
mem | host_usableUsable Memory (KB)Usable host memory in kilobytes.
mem | host_usageUsage (KB)Host memory use in kilobytes.
mem | host_usagePctUsage/Usable (%)Percent host memory used.
Network Metrics for Datacenters
Network metrics provide information about network performance.
Table 5-9. Network Metrics for Datacenters
Metric KeyMetric NameDescription
net | workloadWorkload (%)Percent workload.
net | droppedPctPackets Dropped (%)Percent packets dropped.
net | usage_averageUsage Rate (KBps)The sum of the data transmitted and
received for all the NIC instances of the
host or virtual machine.
net | usage_capacityI/O Usage CapacityIO use capacity.
Storage Metrics for Datacenters
Storage metrics provide information about storage use.
VMware, Inc. 29
Page 30
VMware vCenter Adapter Installation and Configuration Guide
Table 5-10. Storage Metrics for Datacenters
Metric KeyMetric NameDescription
storage | usage_averageTotal Usage (KBps)Average use in kilobytes.
Disk Space Metrics for Datacenters
Disk space metrics provide information about disk use.
Table 5-11. Disk Space Metrics for Datacenters
Metric KeyMetric NameDescription
diskspace | usedVirtual machine used (GB)Used virtual machine disk space in
diskspace | notsharedNot Shared (GB)Unshared disk space in gigabytes.
diskspace | sharedShared Used (GB)Shared disk space in gigabytes.
diskspace | snapshotSnapshot Space (GB)Snapshot disk space in gigabytes.
diskspace | diskusedVirtual Disk Used (GB)Used virtual disk space in gigabtyes.
diskspace | numvmdiskVirtual machine used (GB)Used virtual machine disk space in
gigabytes.
gigabtyes.
Summary Metrics for Datacenters
Summary metrics provide information about overall performance.
Table 5-12. Summary Metrics for Datacenters
Metric KeyMetric NameDescription
summary | number_running_hostsNumber of Running HostsNumber of running hosts.
summary | number_running_vmsNumber of Running VMsNumber of running virtual machines.
summary | total_number_clustersTotal Number of ClustersTotal number of clusters.
summary | total_number_hostsTotal Number of HostsTotal number of hosts.
summary | total_number_vmsTotal Number of VMsTotal number of virtual machines.
summary | total_number_datastoresTotal Number of DatastoresTotal number of datastores.
summary | number_running_vcpusNumber of VCPUs on Powered On
DAS Configuration - Active Admission
Control Policy
DAS Confguration - Admission Control
Policy - CPU Failover Resources Percent
DAS Configuration - Admission Control
Policy - Memory Failover Resources
Percent
DAS Configuration - Admission Control
Policy - Failover Hosts
Enabled DAS configuration
admission controls.
level.
DAS configuration active
admission control policy.
Percent CPU failover resources
for DAS configuration
admission control policy.
Percent memory failover
resoures for DAS configuration
admission control policy.
Failover hosts for DAS
configuration admission control
policy.
Storage Metrics for Cluster Compute Resources
Storage metrics provide information about storage use.
Table 5-14. Storage Metrics for Cluster Compue Resources
Metric KeyMetric NameDescription
storage | usage_averageTotal Usage (KBps)Average use in kilibytes per second.
Disk Space Metrics for Cluster Compute Resources
Disk space metrics provide information about disk space use.
Table 5-15. Disk Space Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
diskspace | usedVirtual machine used (GB)Virtual machine used space in gigabytes.
diskspace | diskusedVirtual Disk Used (GB)Virtual disk used space in gigabytes.
diskspace | snapshotSnapshot Space (GB)Snapshot space in gigabtyes.
diskspace | sharedShared Used (GB)Shared used space in gigabtyes.
diskspace | notsharedNot Shared (GB)Unshared space in gigabytes.
CPU Usage Metrics for Cluster Compute Resources
CPU usage metrics provide information about CPU use.
Table 5-16. CPU Usage Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
cpu | capacity_usagepct_averageCapacity Usage (%)Percent capacity used.
cpu | capacity_contentionPctCPU Contention (%)Percent CPU contention.
VMware, Inc. 31
Page 32
VMware vCenter Adapter Installation and Configuration Guide
Table 5-16. CPU Usage Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
cpu | demandPctDemand (%)Percent demand.
cpu | demandmhzDemand (MHz)Demand in megahertz.
cpu | iowaitIO Wait (ms)IO wait time in milliseconds.
cpu | numpackagesNumber of CPU SocketsNumber of CPU sockets.
cpu | capacity_contentionOverall CPU Contention (ms)Overall CPU contention in milliseconds.
cpu | capacity_provisionedProvisioned Capacity (MHz)Provisioned CPU capacity in megahertz.
cpu | corecount_provisionedProvisioned CPU CoresNumber of provisioned CPU cores.
cpu | reservedCapacity_averageReserved Capacity (MHz)Reserved capacity in megahertz.
cpu | waitWait (ms)Wait time in milliseconds.
cpu | workloadWorkload (%)Percent workload.
cpu | usagemhz_averageUsage (MHz)CPU use in megahertz.
cpu | total_capacityTotal Capacity (MHz)Total CPU capacity in megahertz.
(Continued)
Disk Metrics for Cluster Compute Resources
Disk metrics provide information about disk use.
Table 5-17. Disk Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
disk | commandsAveraged_averageCommands per secondAverage number of commands issued per
second during the collection interval.
disk | totalLatency_averageDisk Command Latency (ms)Average amount of time taken for a command
from the perpsective of the guest operating
system. This metric is the sum of the Kernal
Device Command Latency and Physical
Device Command Latency metrics.
disk | totalReadLatency_averageDisk Read LatencyAverage amount of time for a read operation
from the virtual disk. The total latency is the
sum of kernal latency and device latency.
disk | totalWriteLatency_averageDisk Write LatencyAverage time taken for a write from the
perspective of the guest operating system. This
metric is the sum of the Kernel Write Latency
and Physical Write Latency metrics.
disk | numberRead_summationRead Rate (KBps)Amount of data read during the collection
interval.
disk |
numberReadAveraged_average
disk | usage_averageUsage Rate (KBps)Average of the sum of the data read and
disk | workloadWorkload (%)Percent workload.
disk | numberWrite_summationWrite Rate (KBps)Amount of data written to disk during the
disk |
numberWriteAveraged_average
disk | read_averageRead RequestsNumber of times data was read from the disk
Reads per secondAverage number of read commands issued per
second during the collection interval.
written for all of the disk instances of the host
or virtual machine.
collection interval.
Writes per secondAverage number of write commands issued
per second during the collection interval.
during the collection interval.
32 VMware, Inc.
Page 33
Chapter 5 Metrics for vCenter Server Components
Table 5-17. Disk Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
disk | write_averageWrite RequestsNumber of times data was written to the disk
disk | commands_summationCommands IssuedNumber of disk commands issued during the
(Continued)
during the collection interval.
collection interval.
Memory Metrics for Cluster Compute Resources
Memory metrics provide information about memory use and allocation.
Table 5-18. Memory Metrics for Cluster Computer Resources
Metric KeyMetric NameDescription
mem | activewrite_averageActive Write (KB)Active writes in kilobytes.
mem | compressed_averageCompressed (KB)Average compression in kilobytes.
mem | compressionRate_averageCompression Rate (KBps)Average compression rate in kilobytes.
mem | consumed_averageConsumed (KB)Amount of host memory consumed by the
virtual machine for guest memory.
mem | host_contentionPctContention (%)Percent contention.
mem | host_contentionContention (KB)Contention in kilobytes.
mem | decompressionRate_averageDecompression Rate (KBps)Decompression rate in kilobytes.
mem | granted_averageGranted (KB)Amount of memory available for use.
mem | active_averageGuest Active (KB)Amount of memory that is actively used.
mem | heap_averageHeap (KB)Amount of memory allocated for heap.
mem | heapFree_averageHeap Free (KB)Free space in the heap.
mem | vmmemctl_averageMachine Demand (KB)Amount of memory currently used by the
virtual machine memory control.
mem | workloadOverall Workload (%)Percent overall workload.
mem | overhead_averageOverhead (KB)Amount of memory that is overhead.
mem | host_provisionedProvisioned Memory (KB)Provisioned memory in kilobytes.
mem | reservedCapacity_averageReserved Capacity (KB)Reserved capacity in kilobytes.
mem | shared_averageShared (KB)Amount of shared memory.
mem | sharedcommon_averageShared Common (KB)Amount of shared common memory.
mem | swapin_averageSwap In (KB)Amount of memory that is swapped in for the
service console.
mem | swapinRate_averageSwap In Rate (KBps)Rate at which memory is swapped from disk
into active memory during the interval.
mem | swapout_averageSwap Out (KB)Amount of memory that is swapped out for
the service console.
mem | swapoutRate_averageSwap Out Rate (KBps)Rate at which memory is being swapped from
active memory into disk during the current
interval.
mem | swapused_averageSwap Used (KB)Amount of memory used for swap space.
Total Capacity (KB)Total capacity in kilobytes.
mem | unreserved_averageUnreserved (KB)Amount of unreserved memory.
mem | host_usableUsable Memory (KB)Usable memory in kilobytes.
VMware, Inc. 33
Page 34
VMware vCenter Adapter Installation and Configuration Guide
Table 5-18. Memory Metrics for Cluster Computer Resources
Metric KeyMetric NameDescription
mem | host_usagePctUsage (%)Percent memory used.
mem | host_usageUsage (KB)Memory use in kilobytes.
mem | usage_averageUsage/Usable (%)Memory currently in use as a percentage of
mem | sysUsage_averageVMkernal Usage (KB)Amount of memory that the VMkernal uses.
mem | zero_averageZero (KB)Amount of memory that is all 0.
mem | vmmemctl_averageBalloonAmount of memory currently used by the
(Continued)
total available memory.
virtual machine memory control.
Network Metrics for Cluster Compute Resources
Network metrics provide information about network performance.
Table 5-19. Network Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
net | workloadWorkload (%)Percent workoad.
net | received_averageData Receive Rate (KBps)Data receive rate in kilobytes.
net | transmitted_averageData Transmit Rate (KBps)Date transmission rate in kilobytes.
net | droppedPackets DroppedNumber of packets dropped in the performance
interval.
net | droppedPctPackets Dropped (%)Percent packets dropped.
net | packetsRx_summationPackets ReceivedNumber of packets received in the performance
interval.
net | packetsTx_summationPackets TransmittedAverage of the sum of the data read and written for
all of the disk instances of the host or virtual
machine.
net | droppedRx_summationReceived Packets DroppedNumber of received packets dropped in the
performance interval.
net | droppedTx_summationTransmitted Packets DroppedNumber of transmitted packets dropped in the
performance interval.
net | usage_averageUsage Rate (KBps)Memory currently in use of total available memory.
Cluster Services Metrics for Cluster Compute Resources
Cluster Services metrics provide information about cluster services.
Table 5-20. Cluster Services Metrics for Cluster Compute Resources
Metric KeyMetric NameDescription
clusterServices | effectivecpu_averageEffective CPU Resources (MHz)VMware DRS effective CPU resources
datastore | totalReadLatency_averageRead Latency (ms)Read latency in milliseconds.
datastore | totalWriteLatency_averageWrite Latency (ms)Write latency in milliseconds.
datastore | write_averageWrite Rate (KBps)Write rate in kilobytes per second.
Operations
IOPS
Storage I/O Control normalized
latency (ms)
issued per second during the
collection interval.
Number of outstanding IO
operations.
Aggregate number of IO operations
on the datastore.
Normalized latency in microseconds
on the datastore.
Disk Metrics for Host Systems
Disk metrics provide information about disk use.
Table 5-34. Disk Metrics for Host Systems
Metric KeyMetric NameDescription
disk | usage_averageUsage Rate (KBps)Average of the sum of the data read
and written fro all of the disk
instances of the host or virtual
machine.
disk | workloadWorkload (%)Percent workload.
Supported by ESX 3.5 and later.
disk | usage_averageCommands per secondAverage number of commands
issued per second during the
collection interval.
disk | totalLatency_averageDisk Command Latency (ms)Average amount of time taken for a
command from the perspective of
the guest operating system. This
metric is the sum of the Kernel
Device Command Latency and
Physical Device Command Latency
metrics.
disk | numberReadAveraged_averageReads per secondAverage number of read commands
issued per second during the
collection interval.
40 VMware, Inc.
Page 41
Chapter 5 Metrics for vCenter Server Components
Table 5-34. Disk Metrics for Host Systems (Continued)
Metric KeyMetric NameDescription
disk | numberWriteAveraged_averageWrites per secondAverage number of write
commands issued per second
during the collection interval.
disk | oioNumber of Outstanding IO OperationsNumber of outstanding IO
operations.
disk | queuedQueued OperationsNumber of queued operations.
disk | demandDemandDisk demand.
disk | numberRead_summationRead Rate (KBps)Read rate in kilobytes per second.
disk | numberWrite_summationWrite Rate (KBps)Write rate in kilobytes per second.
disk | read_averageRead RequestsAverage number of read requests.
disk | write_averageWrite RequestsAverage number of write requests.
disk | busResets_summationBus ResetsNumber of bus resets.
disk | commands_summationCommands IssuedNumber of commands issued.
disk | commandsAborted_summationCommands AbortedNumber of commands aborted.
disk | deviceReadLatency_averagePhysical Device Read Latency (ms)Physical device read latency in
milliseconds.
disk | kernelReadLatency_averageKernel Disk Read Latency (ms)Kernel disk read latency in
milliseconds.
disk | totalReadLatency_averageDisk Read Latency (ms)Disk read latency in milliseconds.
disk | queueReadLatency_averageQueue Read Latency (ms)Queue read latency in milliseconds.
disk | deviceWriteLatency_averagePhysical Device Write Latency (ms)Physical device write latency in
milliseconds.
disk | kernelWriteLatency_averageKernel Disk Write Latency (ms)Kernel disk write latency in
milliseconds.
disk | totalWriteLatency_averageDisk Write Latency (ms)Disk write latency in milliseconds.
disk | queueWriteLatency_averageQueue Write Latency (ms)Queue write latency in milliseconds.
disk | deviceLatency_averagePhysical Device Command Latency
(ms)
disk | kernelLatency_averageKernel Disk Command Latency (ms)Kernel disk command latency in
disk | queueLatency_averageQueue Command Latency (ms)Queue command latency in
disk | maxQueueDepth_averageMax Queue DepthMaximum queue depth.
Physical device command latency in
milliseconds.
milliseconds.
milliseconds.
Memory Metrics for Host Systems
Memory metrics provide information about memory use and allocation.
Table 5-35. Memory Metrics for Host Systems
Metric KeyMetric NameDescription
mem | host_contentionPctContention (%)Percent host contention.
mem | host_contentionContention (KB)Host contention in kilobytes.
mem | host_usageESX System Usage (KB)ESX system use in kilobytes.
mem | host_demandMachine Demand (KB)Host demand in kilobytes.
VMware, Inc. 41
Page 42
VMware vCenter Adapter Installation and Configuration Guide
Table 5-35. Memory Metrics for Host Systems (Continued)
Metric KeyMetric NameDescription
mem | host_usageVMOverall Memory used to run VMs on
Host (KB)
Overall memory used to run virtual
machines on the host in kilobytes.
mem | workloadOverall Workload (%)Percent overall workload.
mem | host_provisionedProvisioned Memory (KB)Provisioned memory in kilobytes.
mem | reservedCapacityPctReserved Capacity (%)Percent reserved capacity.
mem | host_usableUsable Memory (KB)Usable memory in kilobytes.
mem | host_usagePctUsage (%)Memory currently in use as a
percentage of total available
memory.
mem | host_systemUsageVMkernel Usage (KB)Amount of memory that the
VMkernel uses.
mem | active_averageGuest Active (KB)Amount of memory that is actively
used.
mem | consumed_averageConsumed (KB)Average consumed memory in
kilobytes.
mem | granted_averageGranted (KB)Amount of memory available for
use.
mem | heap_averageHeap (KB)Amount of memory allocated for
heap.
mem | heapFree_averageHeap Free (KB)Amount of free space in the heap.
mem | overhead_averageVM Overhead (KB)Virtual machine capacity in
kilobytes.
mem | reservedCapacity_averageReserved Capacity (KB)Reserved capacity in kilobytes.
mem | shared_averageShared (KB)Average shared memory in
kilobytes.
mem | sharedcommon_averageShared Common (KB)Average shared common memory
in kilobytes.
mem | swapin_averageSwap In (KB)Amount of memory swapped in.
mem | swapout_averageSwap Out KB)Amount of memory swapped out.
mem | swapused_averageSwap Used (KB)Average used swapped memory in
kilobytes.
mem | unreserved_averageUnreserved (KB)Average unreserved memory in
kilobytes.
mem | vmmemctl_averageBalloon (KB)Amount of memory currently used
by the virtual machine memory
control.
mem | zero_averageZero (KB)Amount of memory that is all zero.
mem | state_latestState (0-3)Overall state of the memory. The
value is an integer between 0 (high)
and 3 (low).
mem | host_usageUsage (KB)Host memory use in kilobytes.
mem | usage_averageUsage/Usable (%)Percent memory used.
mem | swapinRate_averageSwap In Rate (KBps)Average swap-in rate in kilobyte
per second.
mem | swapoutRate_averageSwap Out Rate (KBps)Average swap-out rate in kilobytes
per second.
42 VMware, Inc.
Page 43
Chapter 5 Metrics for vCenter Server Components
Table 5-35. Memory Metrics for Host Systems (Continued)
Metric KeyMetric NameDescription
mem | activewrite_averageActive Write (KB)Average active writes in kilobytes.
mem | compressed_averageCompressed (KB)Average memory compression in
kilobytes.
mem | compressionRate_averageCompression Rate (KBps)Average compression rate in
kilobytes per second.
mem | decompressionRate_averageDecompression Rate (KBps)Decompression rate in kilobytes per
second.
mem | totalCapacity_averageTotal Capacity (KB)Total capacity in kilobytes.
Network Metrics for Host Systems
Network metrics provide information about network performance.
Table 5-36. Network Metrics for Host Systems
Metric KeyMetric NameDescription
net | packetsRxPerSecPackets Received per secondNumber of packets received during the
collection interval.
net | packetsTxPerSecPackets Transmitted per secondNumber of packets transmitted during
the collection interval.
net | usage_averageUsage Rate (KBps)Average number of commands issued
per second during the collection interval.
net | workloadWorkload (%)Percent workload.
net | droppedPackets DroppedNumber of packets dropped during the
collection interval.
net | droppedPctPackets Dropped (%)Percent packets dropped.
net | packetsPerSecPackets per secondNumber of packets transmitted and
received per second.
net | demandDemand (%)Percent demand.
net | transmitted_averageData Transmit Rate (KBps)Data transmission rate in kiblobytes per
second.
net | received_averageData Receive Rate (KBps)Data received rate in kilobytes per
second.
net | packetsRx_summationPackets ReceivedNumber of packets received.
net | packetsTx_summationPackets TransmittedNumber of packets transmitted.
net | droppedRX_summationReceived Packets DroppedNumber of received packages that were
dropped.
net | droppedTX_summationTransmitted Packets DroppedNumber of transmitted packets that were
dropped.
System Metrics for Host Systems
System metrics provide information about the amount of CPU that resources and other applications use.
VMware, Inc. 43
Page 44
VMware vCenter Adapter Installation and Configuration Guide
Table 5-37. System Metrics for Host Systems
Metric KeyMetric NameDescription
sys | PoweredOnPower ON1 if the host system is powered on, 0 if
the host system is powered off, or -1 if
the power state is unknown.
sys | uptime_latestUptime (seconds)Number of seconds since the last
system startup.
sys | DiskUsage_latestDisk Usage (%)Percent disk use.
sys | resourceCpuUsage_averageResource CPU Usage (MHz)Amount of CPU that the Service
Console and other applications use.
sys | resourceCpuAct1_latestResource CPU Active (%) (1 min.
average)
Percentage of resource CPU that is
active. Average value during a oneminute period.
sys | resourceCpuAct5_latestResource CPU Active (%) (5 min.
average)
Percentage of resource CPU that is
active. Average value during a fiveminute period.
sys | resourceCpuAllocMax_latestResource CPU Alloc Max (MHz)Maximum resource CPU allocation in
megahertz.
sys | resourceCpuAllocMin_latestResource CPU Alloc Min (MHz)Minimum resource CPU allocation in
megahertz.
sys | resourceCpuAllocShares_latestResource CPU Alloc SharesNumber of resource CPU allocation
shares.
sys | resourceCpuMaxLimited1_latestResource CPU Max Limited (%) (1
min. average)
Percent of resource CPU that is limited
to the maximum amount. Average
value during a one-minute period.
sys | resourceCpuMaxLimited5_latestResource CPU Max Limited (%) (5
min. average)
Percentage of resource CPU that is
limited to the maximum amount.
Average value during a five-minute
period.
sys | resourceCpuRun1_latestResource CPU Run1 (%)Percent resource CPU for Run1.
sys | resourceCpuRun5_latestResource CPU Run5 (%)Percent resource CPU for Run2.
sys | resourceMemAllocMax_latestResource Memory Alloc Max (KB)Maximum resource memory allocation
in kilobytes.
sys | resourceMemAllocMin_latestResource Memory Alloc Min (KB)Minimum resource memory allocation
in kilobytes.
sys | resourceMemAllocShares_latestResource Memory Alloc SharesNumber of resource memory shares
allocated.
sys | resourceMemCow_latestResource Memory Cow (KB)Cow resource memory in kilobytes.
sys | resourceMemMapped_latestResource Memory Mapped (KB)Mapped resource memory in kilobytes.
sys | resourceMemOverhead_latestResource Memory Overhead (KB)Resource memory overhead in
kilobytes.
sys | resourceMemShared_latestResource Memory Shared (KB)Shared resource memory in kilobytes.
sys | resourceMemSwapped_latestResource Memory Swapped (KB)Swapped resource memory in
kilobytes.
sys | resourceMemTouched_latestResource Memory Touched (KB)Touched resource memory in
kilobytes.
sys | resourceMemZero_latestResource Memory Zero (KB)Zero resource memory in kilobytes.
sys | buildBuild NumberBuild number.
44 VMware, Inc.
Page 45
Chapter 5 Metrics for vCenter Server Components
Table 5-37. System Metrics for Host Systems (Continued)
Metric KeyMetric NameDescription
sys | productStringProduct StringProduct string.
sys | vmotionEnabledvMotion Enabled1 if vMotion is enabled or 0 if vMotion
is not enabled.
Management Agent Metrics for Host Systems
Management agent metrics provide information about memory use.
Table 5-38. Management Agent Metrics for Host Systems
Metric KeyMetric NameDescription
managementAgent | memUsed_averageMemory Used (%)Amount of total configured memory
that is available for use.
managementAgent | swapUsed_averageMemory Swap Used (KB)Sum of the memory swapped by all
powered-on virtual machines on the
host.
managementAgent | swapIn_averageMemory Swap In (KBps)Amount of memory that is swapped in
for the Service Console.
managementAgent | swapOut_averageMemory Swap Out (KBps)Amount of memory that is swapped
out for the Service Console.
Storage Path Metrics for Host Systems
Storage path metrics provide information about data storage use.
Table 5-39. Storage Adapter Metrics for Host Systems
Metric KeyMetric NameDescription
storagePath | totalLatencyTotal Latency (ms)Total latency in milliseconds.
storagePath | usageTotal Latency (KBps)Total latency in kilobytes per second.
storagePath | read_averageRead Rate (KBps)Rate of reading data from the virtual
disk.
storagePath | write_averageWrite Rate (KBps)Write rate in kilobytes per second.
storagePath |
commandsAveraged_average
storagePath |
numberReadAveraged_average
storagePath | totalWriteLatency_averageWrites per secondAverage number of write commands
storagePath | totalWriteLatency_averageRead Latency (ms)Average amount of time for a read
storagePath | maxTotalLatency_latestWrite Latency (ms)Average amount of time for a write
Commands per secondAverage number of commands
issued per second during the
collection interval.
Reads per secondAverage number of read commands
issued per second during the
collection interval.
issued per second during the
collection interval.
operation by the storage adapter.
operation by the storage adapter.
Storage Adapter Metrics for Host Systems
Storage adapter metrics provide information about data storage use.
VMware, Inc. 45
Page 46
VMware vCenter Adapter Installation and Configuration Guide
Table 5-40. Storage Adapter Metrics for Host Systems
Metric KeyMetric NameDescription
storageAdapter | usageTotal Usage (KBps)Total use in kilobytes per second.
storageAdapter |
commandsAveraged_average
storageAdapter |
numberReadAveraged_average
storageAdapter |
numberWriteAveraged_average
storageAdapter | read_averageRead Rate (KBps)Rate of reading data by the storage adapter.
storageAdapter |
totalReadLatency_average
storageAdapter |
totalWriteLatency_average
storageAdapter | write_averageWrite Rate (KBps)Rate of writing data by the storage adapter.
Commands per secondAverage number of commands issued per
second by the storage adapter during the
collection interval.
Reads per secondAverage number of read commands issued per
second by the storage adapter during the
collection interval.
Writes per secondAverage number of write commands issued per
second by the storage adapter during the
collection interval.
Read Latency (ms)Average amount of time for a read operation by
the storage adapter. Total latency is the sum of
kernel latency and device latency.
Write Latency (ms)Average amount of time for a write operation by
the storage adapter. Total latency is the sume of
kernel latency and device latency.
Storage Metrics for Host Systems
Storage metrics provide information about storage use.
Table 5-41. Storage Metrics for Host Systems
Metric KeyMetric NameDescription
storage | commandsAveraged_averageCommands per secondNumber of commands per second.
storage | totalReadLatency_averageRead Latency (ms)Read latency in milliseconds.
storage | read_averageRead Rate (KBps)Read rate in kilobytes.
storage | numberReadAveraged_averageReads per secondReads per second.
storage | totalLatency_averageTotal Latency (ms)Total latency in milliseconds.
storage | usage_averageTotal Usage (KBps)Total storage use in kilobytes per
second.
storage | totalWriteLatency_averageWrite Latency (ms)Write latency in milliseconds.
storage | write_averageWrite Rate (KBps)Write rate in kilobytes per second.
storage | numberWriteAveraged_averageWrites per secondWrites per second.
Sensor Metrics for Host Systems
Sensor metrics provide information about host system cooling.
Table 5-42. Fan Metrics for Host Systems
Metric KeyMetric NameDescription
fan | currentValueSpeed (%)Percent fan speed.
fan | healthStateHealth StateFan health state.
46 VMware, Inc.
Page 47
Chapter 5 Metrics for vCenter Server Components
Table 5-42. Fan Metrics for Host Systems (Continued)
Metric KeyMetric NameDescription
temperature | currentValueTemp CFan temperature in centigrade.
temperature | healthStateHealth StateFan health state.
Power Metrics for Host Systems
Power metrics provide information about host system power use.
Table 5-43. Power Metrics for Host Systems
Metric KeyMetric NameDescription
power | energy_summationEnergy (Watt)Host power use in watts.
power | power_averagePower (Watt)Host power use in watts.
power | powerCap_averagePower Cap (Watt)Host power capacity in watts.
Disk Space Metrics for Host Systems
Disk space metrics provide information about disk space use.
Table 5-44. Disk Space Metrics for Host Systems
Metric KeyMetric NameDescription
diskspace | notsharedNot Shared (GB)Unshared disk space in gigabytes.
diskspace | numvmdiskNumber of Virtual DisksNumber of virtual disks.
diskspace | sharedShared Used (GB)Used shared disk space in gigabytes.
diskspace | snapshotSnapshot Space (GB)Disk space used by snapshots in gigabytes.
diskspace | diskusedVirtual Disk Used (GB)Disk space used by virtual disks in gigabytes.
diskpsace | usedVirtual machine used (GB)Disk space used by virtual machines in gigabytes.
Summary Metrics for Host Systems
Summary metrics provide information about overall host system performance.
Table 5-45. Summary Metrics for Host Systems
Metric KeyMetric NameDescription
summary | capacityCapacity (%)Percent capacity.
summary | number_running_vmsNumber of Running VMsNumber of running virtual machines.
summary | number_vmotionNumber of vMotionsNumber of vMotions.
summary | total_number_vmsTotal Number of VMsTotal number of virtual machines.
badge | timeRemainingStandardTime Remaining - Real TimeReal-time time remaining.
badge | wasteWasteWaste score.
badge | workloadWorkload (%)Percent workload.
Planning and cynclical time remaining.
VMware, Inc. 63
Page 64
VMware vCenter Adapter Installation and Configuration Guide
64 VMware, Inc.
Page 65
Metrics for vCenter Operations
Manager Components6
The vCenter Operations adapter monitors vCenter Operations Manager.
In vCenter Operations Manager 5.6 and later releases, the vCenter Operations adapter collects metrics for
certain vCenter Operations Manager components. These self-monitoring metrics are useful for diagnosing
problems with vCenter Operations Manager.
This chapter includes the following topics:
n
“Analytics Metrics,” on page 65
n
“Collector Metrics,” on page 70
n
“ActiveMQ Service Metrics,” on page 71
n
“Web Server Metrics,” on page 72
n
“Replication Server Metrics,” on page 74
n
“Database Metrics,” on page 74
n
“Host Operating System Metrics,” on page 75
Analytics Metrics
The vCenter Operations adapter collects metrics for the vCenter Operations Manager Analytics service,
including replication
connection, and garbage collector metrics.
dt | fsdbReadTimeFSDB Read Time (ms)FSDB read time.
dt | dtObjectSaveTimeDT Object Save Time (ms)Dynamic threshold save time.
dt | dtHistorySaveTimeDT History Save Time (ms)Dynamic threshold history save
time.
68 VMware, Inc.
Page 69
Chapter 6 Metrics for vCenter Operations Manager Components
Table 6-7. Dynamic Threshold Metrics for the Analytics Service
Metric KeyMetric NameDescription
dt | dtRunTimeDT Run Time (ms)Dynamic threshold run time.
dt | cachedDTObjectCountCached Object CountCached object count since the start
dt | dtCalcTimeDT Calc Time (ms)Time spent calculating dynamic
(Continued)
Available only in 5.7 and later
releases.
time of the current dynamic
threshold run.
Available only in 5.7 and later
releases.
thresholds since the start of the
current dynamic threshold run.
Available only in 5.7 and later
releases.
FSDB Metrics
These metrics are available only in 5.7 and later releases.
Table 6-8. FSDB Metrics for the Analytics Service
Metric KeyMetric NameDescription
fsdb | savedObservationCountSaved Observation countSaved observation count during
the last collection interval.
fsdb | saveObservationOpTimeSave Observation Op Time (ms)Time spent saving the observation
count during the last collection
interval.
fsdb | saveObservationOpTimeAvgSave Observation Op Time Average
(ms)
Average time spent saving the
observation count.
Database Connection Pool Metrics
These metrics are available only in 5.7 and later releases.
Table 6-9. Database Connection Pool Metrics for the Analytics Service
Metric KeyMetric NameDescription
dbConnectionPool | numConnectionsConnection CountNumber of database connections
in the database connection pool.
dbConnectionPool | numIdleConnectionsIdle Connection CountNumber of idle connections in the
database connection pool.
dbConnectionPool | numBusyConnectionsBusy Connection CountNumber of busy connections in the
database connection pool.
dbConnectionPool |
numUnclosedOrphanedConnecions
Unclosed Orphaned Connection
Count
Number of unclosed orphaned
connections in the database
connection pool.
VMware, Inc. 69
Page 70
VMware vCenter Adapter Installation and Configuration Guide
Garbage Collector Metrics
Table 6-10. Garbage Collector Metrics for the Analytics Service
Metric KeyMetric NameDescription
garbageCollector | collectionCountCollection CountGarbage collection count during
garbageCollector | collectionTimeCollection Time (ms)Time spent in garbage collection
Collector Metrics
The vCenter Operations adapter collects metrics for the vCenter Operations Manager Collector service,
including collection statistic and garbage collector metrics.
Table 6-11. Collector Metrics
Metric KeyMetric NameDescription
ThreadpoolThreadsCountPool Threads CountNumber of pool threads.
These metrics are available only in 5.7 and later releases.
Table 6-12. Collection Statistics Metrics for the Collector Service
Metric KeyMetric NameDescription
collection | collectionTimeCollection Time (ms)Time spent in data collection during
the last collection interval.
collection | resourceCountResource CountNumber of resources processed during
the last collection interval.
collection | metricCountMetric CountNumber of metrics processed during
the last collection interval.
Garbage Collector Metrics
These metrics are available only in 5.7 and later releases.
70 VMware, Inc.
Page 71
Table 6-13. Garbage Collector Metrics for the Collector Service
Metric KeyMetric NameDescription
garbageCollector | collectionCountCollection CountGarbage collection count during the
garbageCollector | collectionTimeCollection Time (ms)Time spent in garbage collection
ActiveMQ Service Metrics
The vCenter Operations adapter collects metrics for the vCenter Operations Manager ActiveMQ service,
including queue, broker, database, and garbage collector metrics.
kahaDB | fileSizeFile Size (MB)Total size of the log files in
Garbage Collector Metrics
NOTE These metrics are available only in 5.7 and later releases.
Table 6-18. Garbage Collector Metrics for the ActiveMQ Service
Metric KeyMetric NameDescription
garbageCollector | collectionCountCollection CountGarbage collectdion count during the last
garbageCollector | collectionTimeCollection Time (ms)Time spent in garbage collection during
Web Server Metrics
The vCenter Operations adapter collects garbage collector and global request metrics for the vCenter
Operations Web Server and vCenter Operations Web Std Server components. It also collects CapacityIQ
metrics for the Web Server component.
Table 6-24. Garbage Collector Metrics for the Replication Server
Metric KeyMetric NameDescription
garbageCollector | collectionCountCollection CountGarbage collection count during the last
garbageCollector | collectionTimeCollection Time (ms)Time spent in garbage collection during
Database Metrics
In a vApp installation, the vCenter Operations adapter collects metrics for the Postgres database instance.
These metrics are available only in 5.7 and later releases.
Table 6-25. Database Metrics
Metric KeyMetric NameDescription
postgres | memConsumptionMemory Consumption (KB)Memory that Postgres uses.
collection interval.
the last collection interval.
74 VMware, Inc.
Page 75
Host Operating System Metrics
In a vApp installation, the vCenter Operations adapter collects operating system metrics for each virtual
machine,
releases.
Disk Use Metrics
Table 6-26. Disk Use Metrics
Metric KeyMetric NameDescription
diskUsage | sizeDisk Size (KB)Disk size.
diskUsage | usedUsed Disk Size (KB)Used disk size.
diskUsage | availableAvailable Disk Size (KB)Available disk size.
diskUsage | usePercentUsage (%)Percent used disk size.
Memory Use Metrics
Table 6-27. Memory Use Metrics
Metric KeyMetric NameDescription
including disk use, memory use, and disk IO metrics. These metrics are available only in 5.7 and later
Chapter 6 Metrics for vCenter Operations Manager Components
memUsage | totalTotal (KB)Total memory size.
memUsage | usedUsed (KB)Used memory size.
memUsage | freeFree (KB)Free memory size.
Disk IO Metrics
Table 6-28. Disk IO Metrics
Metric KeyMetric NameDescription
diskIO | numberReadAvgReads per secondNumber of read requests issued to the device
per second.
diskIO | numberWriteAvgWrites per secondNumber of write requests issued to the device
per second.
diskIO | readAvgRead Rate (KBps)Number of kilobytes read from the device per
second.
diskIO | writeAvgWrite Rate (KBps)Average time, in milliseconds, for IO requests
issued to the device to be served. Includes the
time requests spend in the queue and the time
spent servicing the requests in the queue.
diskIO | awaitIO Request Latency (ms)Average time, in milliseconds, for IO requests
to be served. Includes the time that requests
spend in the queue and the time spent
servicing the requests in the queue.
diskIO | utilPercentCPU Time Util (%)Percentage of CPU time during which IO
requests were issued to the device (bandwidth
utilization for the device). Device saturation
occurs when this value is close to 100 percent.
VMware, Inc. 75
Page 76
VMware vCenter Adapter Installation and Configuration Guide
data collection 9
Datacenter resource metrics 28
Datastore metrics 55
H
host operating system metrics 75
Host System metrics 37
R
reducing metrics collected 20
Replication server metrics 74
requirements 10
resource identifiers 11
Resource Pool metrics 35
S
self-monitoring metrics 65
T
troubleshooting steps 21
U
updated information 7
V
vCenter Operations Manager metrics 65
vCenter Server metrics 25
vcenter_adapter3 folder 16
viewing collection information 21
Virtual Machine metrics 48
VM Entity status tag 10
W
Web server metrics 72
I
installing the adapter 15, 16
introduction 9
L
log files 23
M
manual discovery 9
metrics 25
metrics profiles 20
P
Postgres database metrics 74
VMware, Inc. 77
Page 78
VMware vCenter Adapter Installation and Configuration Guide
78 VMware, Inc.
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.