vSphere

Topics marked with * relate to features available only in vFabric Hyperic.

vSphere Plugin Overview

Hyperic's vSphere plugin manages vSphere Hosts and the VMs that run on them, using built-in java plugin classes, the HQApi, and the vCenter SDK.

The vSphere plugin replaces the VMware Infrastructure Manager plugin available in previous versions of Hyperic. The VMware Infrastructure Manager plugin was deprecated in Hyperic 4.4.

Supported Versions and Requirements

The vSphere plugin supports vSphere 5.0, v4.1 and 4.0; ESX 5.0, v4.1 and 4.0; and ESXi 5.0, v4.1 and 4. The plugin requires Hyperic Agent v4.6 or later, and HQApi 5.0.0 or later.

Number of Managed VMs

Testing of the vSphere plugin indicates the Hyperic Agent can manage 1000 VMs without becoming overloaded.

vSphere Resources and the Hyperic Inventory Model

The vSphere plugin defines five Hyperic resource types.

  • VMware vCenter — vCenter is the vSphere management service for administering and managing vSphere Hosts and VMs. The vSphere plugin accesses vCenter functions via the vCenter SDK. You install an Hyperic Agent on the same system as vCenter to enable management of vSphere Hosts and VMs.

  • VMware vSphere Host — A vSphere Host is a physical ESX host for VMs.

  • VMware vSphere Host DS — This resource represents the host datastore.

  • VMware vSphere VM — vSphere VM's run on a vSphere Host. You install an Hyperic Agent in a vSphere VM to enable management of supported server types (such as Tomcat, JBoss or other supported server types) running in the VM. In vFabric Hyperic, if you run a Hyperic Agent on vCenter and on the VMs that the vCenter instance administers, you can correlate VM and managed server behavior in the vFabric Hyperic's HQ vSphere user interface.

  • VMware vSphere VM DS — This resource represents the VM datastore.

The table below shows the vSphere resource type hierarchy; the right column indicates the inventory level for a type in the Hyperic inventory model.

Vsphere Resource Hierarchy

Inventory Type

    VMware vCenter

server (child resource on the platform running vCenter)

VMware vSphere Host

platform

   VMware vSphere Host DS

server

VMware vSphere VM

platform

    VMware vSphere VM DS

server

    Hyperic Agent-managed resource in VM       

server

Note: For more information about how managed resources map to the inventory hierarchy, see Resources, Resource Types and Inventory Types.

Configuration Overview

The vSphere plugin uses SIGAR to discover the vCenter server, and uses the vCenter SDK to manage the hosts and VMs under vCenter management.

You install a Hyperic Agent on a platform that can access vCenter Server over the network. To minimize the load on the vCenter platform, do not install the agent on the same platform as vCenter.

SSL Requirements for 4.6.x Agents

In Hyperic 4.6.x, to communicate with the vCenter server over SSL, you must configure a keystore for the agent and manually import the vCenter SSL certificate into the agent keystore if the server’s certificate is unverified.

To discover and manage vSphere Hosts and VMs, the plugin must be able to connect to the vCenter SDK port, so after vCenter is discovered, you must enable the plugin to connect to the SDK port by defining the SDK connection settings on the vCenter server's Configuration Properties page.

The plugin tries to connect to the SDK port specified on the vCenter instance's Configuration Properties page. Upon successful connection to vCenter, the Hyperic Agent reports the vSphere Hosts and VMs under vCenter management to the Hyperic Server, and starts reporting the availability of the vCenter, the vSphere Hosts it manages, and the VMs in each host.

If a Hyperic Agent is running in a VM, the agent managing the vCenter service will report all currently enabled metrics for the VM, not just availability.

Resource Types and Management Functions

This section defines the management functions that the vSphere plugin provdies for vCenter, vSphere Hosts, and vSphere VMs.

Management Functions for VMware vCenter

The vSphere plugin uses the vCenter SDK to manage vSphere Hosts and the VMs that run in the hosts. The plugin performs two management functions for vCenter instances:

  • Auto-Discovery - The vSphere plugin uses a SIGAR process query to discover a vCenter instance and creates a server of type "VMware vCenter" for it.

  • Metric Collection - The plugin reports the vCenter availability, but no other vCenter metrics.

Management Functions for VMware vSphere Hosts

  • Auto-Discover New Hosts - After you configure the the VMware vCenter instance's SDK connection information, the vSphere plugin uses the SDK to obtain the location and other properties for each of the physical ESX hosts under vCenter management. The plugin creates a platform of type "VMware vSphere Host" for each.

    • vSphere Host Naming - The name of a vSphere Host in Hyperic is made up of its name in vCenter, a space, and, enclosed in brackets, its vCenter-assigned UID. For example, the name in Hyperic for a vSphere Host whose name and UUID in vCenter are "10.16.16.55" and "34313236-3435-5553-4538-30374e39414a", respectively, is:
      10.16.16.55 {34313236-3435-5553-4538-30374e39414a}

    • vSphere Host Properties - The plugin obtains the properties listed below for each vSphere Host. Click the thumbnail below to see the properties as displayed in the Hyperic user interface when you browse to a VMware vSphere Host.

      • Description

      • VMware Version

      • Build

      • IP Address

      • Primary DNS

      • Secondary DNS

      • Default Gateway

      • Manufacturer

      • Model

      • Processor Type

      • vProcessor Sockets

      • Cores per Socket

      • Data Center

        images/download/attachments/79038211/VcenterProperties.png

  • Auto-Discover Changed and Removed Hosts — During each periodic inventory scan, every 15 minutes by default the Hyperic Agent detects changes to the vSphere Host administered by the vCenter instance it monitors. The following changes are detected and reflected in Hyperic inventory:

    • Changed properties for vSphere Hosts

    • Removed vSphere Hosts — The plugin detects removal of a host during the inventory scan subsequent to the host's removal from vCenter. As a result, the host and its dependent resources are removed from Hyperic inventory:

      • The vSphere Host resource is removed from Hyperic inventory.

      • The vSphere VMs that previously ran in on the host are also removed from Hyperic inventory.

      • The operating system platforms associated with Hyperic-managed VMs are removed. (A Hyperic-managed VM is a VM that has or had a Hyperic Agent running in it.)

  • Metric Collection — The org.hyperic.hq.plugin.vsphere.VSphereHostCollector class obtains vCenter Performance Counters for each vSphere host the vCenter Server manages. See VMware vSphere Host Metrics for a list of supported metrics.

  • Event Tracking - The org.hyperic.hq.plugin.vsphere.VSphereHostEventPlugin obtains events for vSphere hosts every 5 minutes. See vSphere Events for a list of all vCenter events. For each event, the following data is returned:

    • Log Level

    • Event ID

    • User

    • Message

Management Functions for VMware vSphere VMs

  • Auto-Discover VMs - The plugin uses the vCenter SDK to discover VMs that the vCenter Server manages, and creates a platform of type "VMware vSphere VM" for each.

    • vSphere VM Naming - The name of a vSphere VM in Hyperic is made up of its name in vCenter, a space, and, enclosed in brackets, its vCenter-assigned UID. For example, the name in Hyperic for a vSphere VM whose name and UUID in vCenter are "vmc-ssrc-centos5.4" and "564d8a4e-3b34-e2ad-e6b5-5807b890bd39", respectively, is:
      vmc-ssrc-centos5.4 {564d8a4e-3b34-e2ad-e6b5-5807b890bd39}

    • vSphere VM Properties The plugin obtains the properties listed below for each VM. Click the thumbnail below to see the properties as displayed in the Hyperic user interface when you browse to a VMware vSphere VM.

      • Guest OS

      • VM Version

      • IP Address

      • MAC Address

      • Hostname

      • ESX Host

      • Resource Pool

      • Memory Size

      • Virtual CPUs

      • Tools Version

      • Config File

        images/download/attachments/79038211/VcenterProperties.png

  • Auto-Discover Changed, Moved, and Removed VMs - - During each periodic inventory scan, every 15 minutes by default, the Hyperic Agent detects changes to the vSphere VMs administered by the vCenter instance it monitors. The following changes are detected and reflected in Hyperic inventory:

    • Changed properties for vSphere VMs.

    • Removed vSphere VMs — The plugin detects removal of a VM during the inventory scan subsequent to the host's removal from vCenter. The vSphere Host resource is removed from Hyperic inventory. Operating system platforms associated with Hyperic-managed VMs are also removed. (An Hyperic-managed VM is a VM that has or had a Hyperic Agent running in it.)

    • vMotions - vMotions are detected, and inventory properties updated to reflect the new host without interruption of monitoring.

  • Metric Collection - The org.hyperic.hq.plugin.vsphere.VSphereVmCollector class obtains vCenter Performance Counters for each VM with a Hyperic Agent. See VMware vSphere VM Metrics for a list of supported metrics.

  • Control - The org.hyperic.hq.plugin.vsphere.VSphereVmControlPlugin class enables these control actions for VMs with an Hyperic Agent:

    • CreateSnapshot - Saves a snapshot of the current state of the VM so that you can return to the same state repeatedly.

    • RemoveAllSnapshots - Commits all the immediate snapshots before the "You are here" current active state to the base disk and removes all existing snapshots for the VM.

    • RevertToCurrentSnapshot - equivalent to "go to the parent snapshot of the VM (the parent snapshot of the "You Are Here" position. Revert immediately activates the parent snapshot of the current state of the VM. The current disk and memory states are discarded, and the VM reverts to the disk and memory states of the parent snapshot.

    • Stop - Stop VM.

    • Start - Start VM.

    • Reset - Resets the VM abruptly, with no consideration for work in progress. If you reset a VM while the virtual disk is being written to, data may be lost or corrupted.

    • Suspend - stops the VM and saves the current state of the VM state and applications running in it; the next resume command returns the VMs and applications to the state they were in when suspend.

    • RebootGuest - Issues a command to the guest operating system asking it to perform a reboot.

    • GuestHeartbeatStatus - The guest heartbeat status, one of:

      • gray - VMware Tools are not installed or not running.

      • red - No heartbeat. Guest operating system may have stopped responding.

      • yellow - Intermittent heartbeat. May be due to guest load.

      • green - Guest operating system is responding normally.

vSphere Components in the Hyperic User Interface

This section introduces the user interface for viewing vSphere resources in Hyperic. In Hyperic Open Source, you use the Resource Hub to view vSphere resources.

vFabric Hyperic has a separate management view — the HQ vSphere page — for monitoring and managing vSphere components.

vSphere Components in the Resource Hub

Follow the instructions in this section to view vSphere components in the Resource Hub.

View a VMware vCenter Instance in the Resource Hub

Use Resources > Browse > Servers > Server Type Dropdown > VMware vCenter to navigate to VMware vCenter instance. The Current Health page for the vCenter instance appears. See the thumbnail below for a screenshot.
images/download/attachments/79038211/VcenterResourceHub.png

View a VMware vSphere Host in the Resource Hub

Use Resources > Browse > Platforms > Platform Type Dropdown > vSphere Host to navigate to a vSphere Host. The Current Health page for the host. See the thumbnail below for a screenshot.
images/download/attachments/79038211/VsphereHostResourceHub.png

View a VMware vSphere VM in the Resource Hub

Use Resources > Browse > Platforms > Platform Type Dropdown > vSphere VM to navigate to a vSphere VM. The Current Health page for the VM. See the thumbnail below for a screenshot.
images/download/attachments/79038211/VsphereVmResourceHub.png

When you browse platforms on the Resources > Browse page, if the filter is set to "All Platform Types", vSphere VMs will not appear in the list of platforms. You must select "vSphere VM" in the platform types filter to display a list of vSphere VMs in the Resource Hub.

vSphere Components in vFabric Hyperic

Use Resources > Browse > HQ vSphere to display the HQ vSphere management interface. For more information, see ui-vSphere.

Configuration Instructions

This section has instructions for enabling the vSphere plugin to manage vSphere Hosts and VMs.

Remove VMware Infrastructure Manager Plugin and Resources

If you currently have pre-4.4 Hyperic Agents monitoring vSphere components with the VMware Infrastructure Manager plugin deprecated in Hyperic 4.4, remove the plugin and VI3 resources from inventory. The resource types are:

  • VMware VI3 VM server

  • VMware VI3 Host platform

  • VMware VI3 Resource Pool server

  • VMware VI3 VM CPU service

  • VMware VI3 VM NIC service

Step 1 - Setup Agent Keystore

Create a keystore for the Hyperic Agent on the on the platform where you will install the agent that will monitor vCenter. Import the vCenter server certificate into the truststore.

SSL Configuration Requirements (Hyperic 4.6 and later)

In Hyperic 4.6 and later there are new SSL configuration requirements for secure communication between a Hyperic 4.6.x agent and a VMware vCenter server.

If the accept.unverified.certificates property in agent.properties is "false", as it is by default, the VMware vCenter server's unverified SSL certificate must be manually imported to a keystore that the Hyperic 4.6.x Agent can access. Otherwise, secure communication between the Hyperic 4.6.x Agent and VMware vCenter server will fail.

If the accept.unverified.certificates property in agent.properties is "true", the vSphere plugin will automatically import the VMware vCenter server's unverified SSL certificate to the keystore accessible to the Hyperic 4.6.x agent. This is not recommended because it is less secure and expose the Hyperic Agent to man-in-the-middle attacks.

Step 2 - Install Hyperic Agent

Install a Hyperic Agent on the platform from which you will remotely monitor vCenter Server. For instructions, see Install an Agent-Only Package in Getting Started with vFabric Hyperic.

Interactive Agent Configuration is Not Supported

You must configure the Hyperic Agent in its properties file. Do not start the Hyperic Agent until you have configured its startup setting in its agent.properties file, as described in the following section.

Step 3 - Configure Agent Properties

The vSphere plugin reads the agent.properties file for the Hyperic Agent to get the connection properties the Hyperic Agent and Hyperic Server use to communicate with one another. You must edit the agent.properties file to supply the connection property values.

  1. Open AgentHome/conf/agent.properties in a text editor.

  2. Configure the username and password the agent will use for connecting to the Hyperic Server. Uncomment and set the values of:

     
    agent.setup.camLogin= 
    agent.setup.camPword= 

  3. Configure the location of the agent keystore (supply the full path) and the keystore password. Uncomment and set the values of:

    agent.keystore.path
    agent.keystore.password

  4. Configure frequency of default auto-scan. (Optional) Auto-discovery and auto-syncing of vSphere resources occur during the agent default scan (every 15 minutes by default). You can update this time interval by uncommenting and editing this property definition:

     
    # autoinventory.defaultScan.interval.millis=900000

  5. Save and close agent.properties

  6. Start the agent.

    • After it starts up, the Hyperic Agent should discover the vCenter server and present it in the Auto-Discovery Portlet on the Hyperic Dashboard. Import the discovered vCenter server to inventory.

Step 5 - Configure vCenter Server Access Credentials

  1. Navigate to the  Configuration Properties page for the VMware vCenter instance.

    images/download/attachments/79038211/vCenterConfigurationProperties.png

  2. Enter the vCenter SDK URL, supplying an URL with a fully-qualified domain name or an IP address.

    vCenter URLs must be unique

    Due to a known problem (https://jira.hyperic.com/browse/HQ-2418), each vCenter Server resource managed by Hyperic must be configured with a unique URL. If multiple vCenter Server resources are defined with the same URL, for instance the default

    http://localhost/sdk

    all discovered Hosts and VMs will appear under one of the vCenter Server instances.

  3. Enter the username and password for connecting to vCenter.

    Required Privileges

    The vCenter user account that the Hyperic Agent uses to connect to vCenter must have a vCenter role with the following privileges:

    • Virtual machine > Interaction > Power Off, Power On, Reset, and Suspend.

    • Virtual machine > State > Create Snapshot, Remove Snapshot, Rename Snapshot, and Revert Snapshot.

    Limit Discovery of ESX Hosts

    If you wish to prevent the Hyperic Agent from discovering all ESX Hosts managed by the vCenter Server, create a vCenter user with a role that has access to only those ESX Hosts you want to monitor, and configure the vCenter resource in Hyperic with those credentials.

    • vSphere Hosts and VMs are automatically imported into inventory. They do not appear in the Auto-Discovery Portlet on the Hyperic Dashboard.

    • Only VMs that are powered on and have a MAC address will be discovered.

    • Soon, metrics should appear on the Monitor tab for a vSphere resource.

      Solving Problems

      If the agent does not start to report metrics for vSphere Hosts and VMs:

      • Verify that you have correctly specified the vCenter SDK URL, using a fully-qualified domain name or an IP address.

        • Because Hyperic can monitor multiple vCenter servers, the vCenter SDK URL for each must be unambiguous; if you use localhost when configuring the SDK URLs (rather than an FQDN or IP address), the various vCenter SDK URLs will be non-unique, resulting in erroneous vCenter > Host > VM hierarchies.

      • Verify that the Username and Password you configured are valid credentials for access the SDK.

      • Verify that the Hyperic Agent has network connectivity and can reach the API port on the platform where vCenter runs — check to see if it is blocked by a firewall.

Step 6 - Set Event Tracking Options

You can enable log tracking for vSphere Hosts and VMs. If you do, the agent will log an event for vCenter events that match the criteria you specify. Note that if you enable log tracking for vSphere VMs, Hyperic will log an event for each control action command performed on the VM from Hyperic. If log tracking is not enabled for a VM, control actions will not be tracked as events.

Note: This version of the vSphere plugin returns all events as level INFO. You cannot define filter criteria based on severity level in this version of the vSphere plugin. You can only filter based on message content - you can track events based on whether it matches or does not match a regular repression. See vSphere Events for a list of all vCenter events.

To enable log tracking, click the Enable Log Tracking box in the Monitoring section of the Configuration Properties page.

For information about Hyperic log tracking functionality and configuration options, and how to view log events, see Set Up Log Tracking for a Resource.

Step 7 - Configure vCenter Statistics Level

The metrics the plugin can collect is limited by the the value of vCenter's Statistics Level setting, which by default is level 1. Level 1 provides only basic performance information. To enable additional metrics, you may wish to increase the Statistics Level setting.

vCenter Statistics Levels

When changing the level of vCenter statistic to collect, consider the overhead that detailed statistics impose on vCenter and vSphere Hosts. Level 1 has very low overhead on VirtualCenter server and ESXhosts. Levels 2 – 4 have only slightly greater overhead on ESX, but can adversely impact VirtualCenter performance if there are more than 10 ESX Server hosts. Level 4 can quickly fill the VirtualCenter database, so it should only be turned on for limited periods of time.

For more information, see Collection Levels in vSphere Basic System Administration.

Step 8 - Tailor Plugin Monitoring Defaults

You can enable and disable metrics, select indicator metrics, and change the collection interval for a resource type on its Monitoring Defaults page. To navigate to a resource type's Monitoring Defaults page:

  1. Click the Administration tab.

  2. Click Monitoring Defaults.

  3. Scroll down to the resource type and click Edit Metric Template.

    • Click the thumbnails below to view the Monitoring Defaults pages for vSphere Hosts and VMs.

      images/download/attachments/79038211/VsphereHostMonitoringDefaults.png

      images/download/attachments/79038211/VsphereVmMonitoringDefaults.png

Step 9 - Install Hyperic Agents in VMs

Installing a Hyperic Agent in each VM enables you to manage Hyperic-supported server types running in it. In vFabric Hyperic, this enables you to correlate the behavior of resources throughout the managed resource hierarchy — from vCenter to managed servers in the VM.

For installation instructions, see Install an Agent-Only Package in Getting Started with vFabric Hyperic.

Note: If you run a Hyperic Agent in a VM, Hyperic creates an operating system type platform type for it in inventory. For instance, if you run and agent in a VM running Linux, Hyperic creates a platform of type "Linux" for the system, in addition to the platform of type "vSphere VM" create for the VM itself.

Step 10 - Configure Alert Definitions

Create alert definitions as desired for your managed vSphere components.

About Alert Processing for vSphere Resources

If a VM has an agent running in it, If a VM is suspended or powered off, "down" alerts on the "associated platform" (the platform that is represented in Hyperic when you install an agent on the VM) will not fire.

Metric Documentation

The following sections define the metrics available.

VMware vSphere Host Metrics

Name

Alias

vCenter Statistics Level

Definition

Units

Category

Default On

Default Interval

Availability

Availability

n/a, Availability is determined by HQ; it is not a vCenter statistic.

The plugin determines a vSphere Host's availability by querying vCenter for the host's power state, once per minute, by default. Availability takes these values:If the power state is:

  • Up — if vSphere Host power state is poweredOn.

  • Paused — if vSphere Host power state is standby.

  • Powered Off — if vSphere Host power state is poweredOff.

  • Down — if the vSphere Host power state is none of the above.

percentage

AVAILABILITY

true

1 min

Uptime

sys.uptime.latest

 

 

sec

AVAILABILITY

false

1 min

CPU Usage (Average)

cpu.usage.average

1

CPU usage as a percentage during the interval.
Actively used CPU of the host, as a percentage of the total available CPU. Active CPU is approximately equal to the ratio of the used CPU to the available CPU.
available CPU = # of physical CPUs × clock rate
100% represents all CPUs on the host. For example, if a four-CPU host is running a virtual machine with two CPUs, and the usage is 50%, the host is using two CPUs completely.

percent

UTILIZATION

true

5 min

Disk Usage (Average)

disk.usage.average

1

Aggregated disk I/O rate. For a vSphere host, this includes the rates for all virtual machines running on the host during the collection interval.

KB per second

UTILIZATION

true

5 min

Highest Disk Latency

disk.maxTotalLatency.latest

1

Highest latency value across all disks used by the host. Latency measures the time taken to process a SCSI command issued by the guest OS to the virtual machine. The kernel latency is the time VMkernel takes to process an IO request. The device latency is the time it takes the hardware to handle the request.
Total latency = kernelLatency + deviceLatency

ms

UTILIZATION

true

5 min

Memory Usage (Average)

mem.usage.average

1

memory usage = memory consumed ÷ host configured memory size

percent

UTILIZATION

true

5 min

Network Usage (Average)

net.usage.average

1

Sum of the data transmitted and received during the collection interval.Sum of data transmitted and received across all physical NIC instances connected to the host.

KB

UTILIZATION

true

5 min

CPU Reserved Capacity

cpu.reservedCapacity.average

2

Total CPU capacity reserved by the virtual machines.

none

UTILIZATION

false

5 min

CPU Throttled (1 min. Average)

rescpu.maxLimited1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Throttled (5 min. Average)

rescpu.maxLimited5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Throttled (15 min. Average)

rescpu.maxLimited15.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (1 min. Average)

rescpu.runav1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (5 min. Average)

rescpu.runav5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (15 min. Average)

rescpu.runav15.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (1 min. Average)

rescpu.actav1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (5 min. Average)

rescpu.actav5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (15 min. Average)

rescpu.actav15.latest

3

 

percent

UTILIZATION

false

5 min

Memory Swap In

mem.swapin.average

2

Sum of memory swapin of all powered on VMs on the host.

KB

UTILIZATION

false

5 min

Memory Swap Out

mem.swapout.average

2

Sum of Memory Swap Out of all powered on VMs on the host.

KB

UTILIZATION

false

5 min

Memory Swap Used

mem.swapused.average

2

Amount of memory that is used by swap. Sum of Memory Swapped of all powered on virtual machines and vSphere services on the host.

KB

UTILIZATION

false

5 min

Memory Balloon

mem.vmmemctl.average

1

Sum of Memory Balloon (Amount of memory allocated by the virtual machine memory control driver) of all powered on virtual machines and vSphere services on the host. If the balloon target value is greater than the balloon value, the VMkernel inflates the balloon, causing more virtual machine memory to be reclaimed. If the balloon target value is less than the balloon value, the VMkernel deflate the balloon, which allows the virtual machine to consume additional memory if needed.

KB

UTILIZATION

true

5 min

Memory Unreserved

mem.unreserved.average

2

Amount of memory that is unreserved. Memory reservation not used by the Service Console, VMkernel, vSphere services and other powered on VMs' user-specified memory reservations and overhead memory.

KB

UTILIZATION

false

5 min

Memory Heap

mem.heap.average

2

Amount of VMkernel virtual address space dedicated to VMkernel main heap and related data.

KB

UTILIZATION

false

5 min

Memory Heap Free

mem.heapfree.average

2

Amount of free address space in the VMkernel's main heap. Heap Free varies, depending on the number of physical devices and various configuration options. There is no direct way for the user to increase or decrease this statistic.

KB

UTILIZATION

false

5 min

Memory Overhead

mem.overhead.average

1

Total of all overhead metrics (Amount of additional machine memory allocated to a virtual machine for overhead. The overhead amount is beyond the reserved amount).for powered-on virtual machines, plus the overhead of running vSphere services on the host.

KB

UTILIZATION

false

5 min

Memory Zero

mem.zero.average

2

Amount of memory that is zeroed out (contains only 0s). This statistic is included in Memory Shared. For a vSphere Host, Sum of Memory Zero of all powered on VMs and vSphere services on the host.

KB

UTILIZATION

false

5 min

Memory Reserved Capacity

mem.reservedCapacity.average

2

Total amount of memory reservation used by powered on VMs and vSphere services on the host. Includes overhead amount.

MB

UTILIZATION

false

5 min

Memory Active

mem.active.average

2

Amount of memory actively used, as estimated by VMkernel. Active memory is based on the current workload of the virtual machine or host.
For a vSphere Host, sum of the active guest physical memory of all powered on virtual machines on the host, plus memory used by basic VMKernel applications on the host.

KB

UTILIZATION

true

5 min

Memory Shared

mem.shared.average

2

Sum of the shared memory values of all powered-on virtual machines, plus the amount for the vSphere services on the host. The host's Memory Shared may be larger than the amount of machine memory if memory is overcommitted (the aggregate virtual machine configured memory is much greater than machine memory). The value of this statistic reflects how effective transparent page sharing and memory overcommitment are for saving machine memory.

KB

UTILIZATION

true

5 min

Memory Granted

mem.granted.average

2

The total of all granted metrics for all powered-on virtual machines, plus memory for vSphere services on the host.

KB

UTILIZATION

false

5 min

Memory Consumed

mem.consumed.average

1

Amount of machine memory used on the host. Consumed memory includes memory used by virtual machines, the service console, VMkernel, and vSphere services, plus the total consumed memory for all running virtual machines.
host consumed memory = total host memory - free host memory

KB

UTILIZATION

false

5 min

Memory State

mem.state.latest

2

Amount of free machine memory on the host. VMkernel has four free-memory thresholds that affect the mechanisms used for memory reclamation.
0 (High) - Free memory >= 6% of machine memory - service console memory
1 (Soft) - Free memory >= 4% of machine memory - service console memory
2 (Hard) - Free memory >= 2% of machine memory - service console memory
3 (Low)- Free memory >= 1% of machine memory - service console memory
For 0 and 1, swapping is favored over ballooning. For 2 and 3, ballooning is favored over swapping.

none

UTILIZATION

false

5 min

Memory Shared Common

mem.sharedcommon.average

2

Amount of machine memory that is shared by all powered-on virtual machines and vSphere services on the host.
Memory Shared - Memory Shared Common = Host memory saved by sharing

KB

UTILIZATION

false

5 min

Memory Used by vmkernel

mem.sysUsage.average

2

Amount of memory used by the VMkernel. Amount of machine memory used by the VMkernel for "core" functionality (such as its own internal uses, device drivers, etc). It does not include memory used by VMs or by vSphere services.

KB

UTILIZATION

false

5 min

VMware vSphere Host DS Metrics

Name

Alias

Units

Category

Default On

Default Interval

Availability

Availability

percentage

AVAILABILITY

true

5 min

Average read requests per second

datastore.numberReadAveraged.average

none

UTILIZATION

true

5 min

Average write requests per second

datastore.numberWriteAveraged.average

none

UTILIZATION

true

5 min

Read latency

datastore.totalReadLatency.average

ms

UTILIZATION

true

5 min

Write latency

datastore.totalWriteLatency.average

ms

UTILIZATION

true

5 min

Storage I/O Control aggregated IOPS

datastore.datastoreIops.average

none

UTILIZATION

false

5 min

Storage I/O Control normalized latency

datastore.sizeNormalizedDatastoreLatency.average

none

UTILIZATION

false

5 min

Storage DRS datastore read I/O rate

datastore.datastoreReadIops.latest

none

UTILIZATION

false

5 min

Storage DRS datastore write I/O rate

datastore.datastoreWriteIops.latest

none

UTILIZATION

false

5 min

Storage DRS datastore outstanding read requests

datastore.datastoreReadOIO.latest

none

UTILIZATION

false

5 min

Storage DRS datastore outstanding write requests

datastore.datastoreWriteOIO.latest

none

UTILIZATION

false

5 min

Storage I/O Control datastore maximum queue depth

datastore.datastoreMaxQueueDepth.latest

none

UTILIZATION

false

5 min

VMware vSphere VM Metrics

Name

Alias

vCenter Statistics Level

Definition

Units

Category

Default On

Default Interval

Availability

Availability

n/a, Availability is determined by HQ; it is not a vCenter statistic.

The plugin determines a VM's availability by querying vCenter for a VM power state, once per minute, by default. Availability takes these values:If the power state is:

  • Up — if VM power state is poweredOn.

  • Paused — if VM power state is standby.

  • Powered Off — if VM power state is poweredOff.

  • Unknown — if the VM power state is none of the above.

  • Down — if VM availability was not reported for a duration equal to, or greater than, twice the configured collection interval, which is 1 minute, by default.

percentage

AVAILABILITY

true

1 min

Uptime

sys.uptime.latest

1

 

sec

AVAILABILITY

false

1 min

CPU Usage (Average)

cpu.usage.average

1

CPU usage as a percentage during the interval.

This value is reported with 100% representing all processor cores on the system. As an example, a 2-way VM using 50% of a four-core system is completely using two cores.

percent

UTILIZATION

true

5 min

Disk Usage (Average)

disk.usage.average

1

Aggregated disk I/O rate.

KB per second

UTILIZATION

true

5 min

Memory Usage (Average)

mem.usage.average

1

The percentage of memory used as a percent of all available machine memory.

percent

UTILIZATION

true

5 min

Network Usage (Average)

net.usage.average

1

Sum of the data transmitted and received during the collection interval.

KB

UTILIZATION

true

5 min

CPU Throttled (1 min. Average)

rescpu.maxLimited1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Throttled (5 min. Average)

rescpu.maxLimited5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Throttled (15 min. Average)

rescpu.maxLimited15.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (1 min. Average)

rescpu.runav1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (5 min. Average)

rescpu.runav5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Running (15 min. Average)

rescpu.runav15.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (1 min. Average)

rescpu.actav1.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (5 min. Average)

rescpu.actav5.latest

3

 

percent

UTILIZATION

false

5 min

CPU Active (15 min. Average)

rescpu.actav15.latest

3

 

percent

UTILIZATION

false

5 min

Memory Swap In

mem.swapin.average

2

Average memory Swap In. A large number here represents a problem with lack of memory and a clear indication that performance is suffering as a result.

KB

UTILIZATION

false

5 min

Memory Swap Out

mem.swapout.average

2

Average Memory Swap Out. A large number here represents a problem with lack of memory and a clear indication that performance is suffering as a result.

KB

UTILIZATION

false

5 min

Memory Balloon

mem.vmmemctl.average

1

Sum of Memory Balloon (Amount of memory allocated by the virtual machine memory control driver)

If the balloon target value is greater than the balloon value, the VMkernel inflates the balloon, causing more virtual machine memory to be reclaimed. If the balloon target value is less than the balloon value, the VMkernel deflate the balloon, which allows the virtual machine to consume additional memory if needed.

KB

UTILIZATION

true

5 min

Memory Balloon Target

mem.vmmemctltarget.average

2

 

KB

UTILIZATION

false

5 min

Memory Zero

mem.zero.average

2

Amount of memory that is zeroed out (contains only 0s). This statistic is included in Memory Shared.

For a vSphere Host, Sum of Memory Zero of all powered on VMs and vSphere services on the host.

KB

UTILIZATION

false

5 min

Memory Active

mem.active.average

2

Amount of memory actively used, as estimated by VMkernel. Active memory is based on the current workload of the virtual machine or host.

For a vSphere Host, sum of the active guest physical memory of all powered on virtual machines on the host, plus memory used by basic VMKernel applications on the host.

KB

UTILIZATION

true

5 min

Memory Shared

mem.shared.average

2

The average amount of shared memory. Shared memory represents the entire pool of memory from which sharing savings are possible. The amount of memory that this has been condensed to is reported in shared common memory. So, total saving due to memory sharing equals shared memory minus shared common memory.

KB

UTILIZATION

true

5 min

Memory Granted

mem.granted.average

2

The amount of memory that was granted to the VM by the host. Memory is not granted to the host until it is touched one time and granted memory may be swapped out or ballooned away if the VMkernel needs the memory.

KB

UTILIZATION

false

5 min

Memory Consumed

mem.consumed.average

1

The amount of machine memory that is in use by the VM.

While a VM may have been configured to use 4 GB of RAM, as an example, it might have
only touched half of that. Of the 2 GB left, half of that might be
saved from memory sharing. That would result in 1 GB of consumed memory.

KB

UTILIZATION

false

5 min

VMware vSphere VM DS Metrics

Name

Alias

Units

Category

Default On

Default Interval

Availability

Availability

percentage

AVAILABILITY

true

5 min

Average read requests per second

datastore.numberReadAveraged.average

none

UTILIZATION

true

5 min

Average write requests per second

datastore.numberWriteAveraged.average

none

UTILIZATION

true

5 min

Read latency

datastore.totalReadLatency.average

ms

UTILIZATION

true

5 min

Write latency

datastore.totalWriteLatency.average

ms

UTILIZATION

true

5 min