VMware vSphere monitoring integration

BETA

New Relic's VMware vSphere integration helps you understand the health and performance of your vSphere environment. You can:

  • Query data to get insights on the performance on your hypervisors, virtual machines, and more.
  • Go from high level views down to the most granular data.
Sample dashboard - VMware vSphere Integration
vSphere data visualized in a New Relic One dashboard: operating systems, status, average CPU and memory consumption, and more.

Our integration uses the vSphere API to collect metrics and events generated by all vSphere's components, and it forwards the data to our platform via the Infrastructure agent.

Why it matters

With our vSphere integration you can:

  • Monitor the health of your hypervisors and virtual machines using our extensive collection of charts and dashboards.
  • Set alerts based on any metrics collected from vCenter.

  • Stream metrics and events from platform components and health metrics like resource pools and datastores.

  • Scale the number of items we collect data on.

  • Use the data retrieved to monitor key performance and key capacity scaling indicators.

  • Instrument and monitor multiple vSphere instances using the same account.

Compatibility and requirements

Our integration is compatible with VMware vSphere 6.0 or higher.

Before installing the integration, make sure that you meet the following requirements:

  • New Relic Infrastructure Pro subscription or trial

  • The New Relic Infrastructure agent installed on a supported host

  • vCenter service account having at least read-only global permissions with the propagate to children option checked​

Install and activate

To install the vSphere integration, choose your setup:

Linux installation
  1. Follow the instructions for installing an integration, using the file name nri-vsphere.
  2. Change the directory to the integrations folder:
    cd /etc/newrelic-infra/integrations.d
  3. Copy of the sample configuration file:
    sudo cp vsphere-config.yml.sample vsphere-config.yml
  4. Edit the vsphere-config.yml file as described in the configuration settings.
  5. Restart the infrastructure agent.
Windows installation
  1. Download the nri-vsphere MSI installer image from:

    https://download.newrelic.com/infrastructure_agent/windows/integrations/nri-vsphere/nri-vsphere-amd64.msi

  2. To install from the Windows command prompt, run:
    msiexec.exe /qn /i PATH\TO\nri-vsphere-amd64.msi
  3. In the Integrations directory, C:\Program Files\New Relic\newrelic-infra\integrations.d\, create a copy of the sample configuration file by running:

    cp vsphere-config.yml.sample vsphere-config.yml
  4. Edit the vsphere-config.yml file as described in the configuration settings.
  5. Restart the infrastructure agent.
Tarball installation (advanced)

You can also install the integration from a tarball file. This gives you full control over the installation and configuration process.

Configure the integration

An integration's YAML-format configuration is where you can place required login credentials and configure how data is collected. Which options you change depend on your setup and preference.

Here is an example of the vSphere integration configuration:

vsphere-config.yml
integrations:
  - name: com.newrelic.vsphere
    exec:
      # Do not change this path
      - /var/db/newrelic-infra/newrelic-integrations/bin/nri-vsphere
      # vSphere API connection data (vCenter or ESXi servers)
      - --url
      - https://YOUR_VSPHERE_URL/sdk
      - --user
      - YOUR_VSPHERE_USER
      - --pass
      - YOUR_VSPHERE_PASSWORD
      - --validate_ssl
      # DC location label can be added to all entities in this vSphere
      #- --datacenter_location
      #- YOUR_VSPHERE_LOCATION_LABEL
    inventory_source: metadata/system 
    env:
      # Proxy configuration can be set up. For more information, see the docs.
      # Uncomment the lines above to add a proxy
      # HTTP_PROXY: socks5://YOUR_PROXY_URL:PROXY_PORT
      # HTTPS_PROXY: socks5://YOUR_PROXY_URL:PROXY_PORT
    interval: 60s

For more information, see our documentation about the general structure of on-host integration configurations.

Update your integration

On-host integrations do not automatically update. For best results, regularly update the integration package and the Infrastructure agent.

View and use data

Data from this service is reported to an integration dashboard. You can query this data for troubleshooting purposes or to create charts and dashboards.

vSphere data is attached to these event types:

  • VSphereHostSample
  • VSphereClusterSample
  • VSphereVmSample
  • VSphereDatastoreSample
  • VSphereDatacenterSample
  • VSphereResourcePoolSample

For more on how to view and use your data, see Understand integration data.

Metric data

The vSphere integration provides the following metric data:

VSphereHost

Name Description Enabled by default
cpu.totalMHz Sum of the MHz for all the individual cores on the host Yes
cpu.coreMHz Speed of the CPU cores Yes
cpu.available Amount of free CPU MHz in the host Yes
cpu.overallUsage CPU usage across all cores on the host in MHz Yes
cpu.percent Percentage of CPU utilization in the host Yes
cpu.cores Number of physical CPU cores on the host. Physical CPU cores are the processors contained by a CPU package Yes
cpu.threads Number of physical CPU threads on the host Yes
disk.totalMiB Total capacity of disks mounted in host, in MiB Yes
mem.free Amount of available memory in the host, in MiB Yes
mem.usage Amount of used memory in the host, in MiB Yes
mem.size Total memory capacity of the host, in MiB Yes
vmCount Number of virtual machines in the host Yes
hypervisorHostname Name of the host Yes
uuid The hardware BIOS identification Yes
datacenterName Name of the datacenter related to the host Yes
clusterName Name of the cluster related to the host Yes
resourcePoolNameList List of names of the resource pools related to the host Yes
datastoreNameList List of names of datastores related to the host Yes
networkNameList List of names of networks related to the host Yes

overallStatus

  • gray: Status is unknown
  • green: Entity is OK
  • yellow: Entity might have a problem
  • red: Entity definitely has a problem
Yes
connectionState The host connection state:
  • connected: Connected to the server. For ESX Server, this is the default setting.
  • disconnected: The user has explicitly taken the host down. VirtualCenter does not expect to receive heartbeats from the host. The next time a heartbeat is received, the host is moved to the connected state again and an event is logged.
  • notResponding: VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again. This state is typically used to trigger an alarm on the host.
Yes
inMaintenanceMode The flag to indicate whether or not the host is in maintenance mode. This flag is set when the host has entered the maintenance mode. It is not set during the entering phase of maintenance mode. Yes
inQuarantineMode

The flag to indicate whether or not the host is in quarantine mode. InfraUpdateHa will recommend to set this flag based on the HealthUpdates received by the HealthUpdateProviders configured for the cluster.

A host that is reported as degraded will be recommended to enter quarantine mode, while a host that is reported as healthy will be recommended to exit quarantine mode. Execution of these recommended actions will set this flag.

Hosts in quarantine mode will be avoided by vSphere DRS as long as the increased consolidation in the cluster does not negatively affect VM performance.

Yes
powerState The host power state:
  • poweredOff: The host was specifically powered off by the user through VirtualCenter. This state is not a cetain state, because after VirtualCenter issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.
  • poweredOn: The host is powered on. A host that is entering standby mode entering is also in this state.
  • standBy: The host was specifically put in standby mode, either explicitly by the user or automatically by DPM. This state is not a certain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to power off. A host that is exiting standby mode s also in this state.
  • unknown: If the host is disconnected or notResponding, we know its power state, so the host is marked as unknown.
Yes
standbyMode

The host’s standby mode. The property is only populated by vCenter server. If queried directly from the ESX host, the property is unset.

  • entering: The host is entering standby mode.
  • exiting: The host is exiting standby mode.
  • in: The host is in standby mode.
  • none: The host is not in standby mode, and it is not in the process of entering or exiting standby mode.
Yes
cryptoState

Encryption state of the host. Valid values are enumerated by the CryptoState type:

  • incapable: The host is not safe for receiving sensitive material.
  • prepared: The host is prepared for receiving sensitive material but does not have a host key set yet.
  • safe: The host is crypto safe and has a host key set.
Yes
bootTime The time when the host was booted. Yes

VSphereVm

Name Description Enabled by default
mem.size Memory size of the virtual machine, in MiB Yes
mem.usage Guest memory utilization statistics, in MiB. This is also known as active guest memory. The value can range between 0 and the configured memory size of the virtual machine. Valid while the virtual machine is running. Yes
mem.free Guest memory available, in MiB. The value can range between 0 and the configured memory size of the virtual machine. Valid while the virtual machine is running. Yes
mem.ballooned The size of the balloon driver in the virtual machine, in MiB. The host will inflate the balloon driver to reclaim physical memory from the virtual machine. This is a sign that there is memory pressure on the host. Yes
mem.swapped The portion of memory, in MiB, that is granted to this virtual machine from the host's swap space. This is a sign that there is memory pressure on the host. Yes
mem.swappedSsd The amount of memory swapped to fast disk device such as SSD, in MiB Yes
cpu.allocationLimit Resource limits for CPU, in MHz. If set to -1, there is no fixed allocation limit. Yes
cpu.overallUsage Basic CPU performance statistics, in MHz. Valid while the virtual machine is running. Yes
cpu.hostUsagePercent Percent of the host CPU used by the virtual machine. In case a limit is configured, the percentage is calculated by taking the limit as the total. Yes
cpu.cores Number of processors in the virtual machine Yes
disk.totalMiB Total storage space, committed to this virtual machine across all datastores, in MiB Yes
ipAddress Guest IP address, if available Yes
connectionState

Indicates whether or not the virtual machine is available for management:

  • connected: Server has access to the virtual machine.
  • disconnected: Server is currently disconnected from the virtual machine, since its host is disconnected.
  • inaccessible: One or more of the virtual machine configuration files are inaccessible.
  • invalid: The virtual machine configuration format is invalid.
  • orphaned: The virtual machine is no longer registered on its associated host.
Yes
powerState The current power state of the virtual machine: poweredOff, poweredOn, or suspended. Yes
guestHeartbeatStatus
  • gray: Status is unknown.
  • green: Entity is OK.
  • yellow: Entity might have a problem.
  • red: Entity definitely has a problem.
Yes
operatingSystem Operating system of the virtual machine Yes
guestFullName Guest operating system full name, if available from guest tools Yes
hypervisorHostname Name of the host where the virtual machine is running Yes
instanceUuid Unique identification of the virtual machine Yes
datacenterName Name of the datacenter Yes
clusterName Name of the cluster Yes
resourcePoolNameList List of names of the resource pools Yes
datastoreNameList List of names of datastores Yes
networkNameList List of names of networks Yes
overallStatus
  • gray: Status is unknown.
  • green: Entity is OK.
  • yellow: Entity might have a problem.
  • red: Entity definitely has a problem.
Yes

VSphereDatastore

Name Description Enabled by default
capacity Maximum capacity of this datastore, in GiB, if accessible is true Yes
freeSpace Available space of this datastore, in GiB, if accessible is true Yes
uncommitted Total additional storage space, potentially used by all virtual machines on this datastore, in GiB, if accessible is true Yes
vmCount Number of virtual machines attached to the datastore Yes
hostCount Number of hosts attached to the datastore Yes
overallStatus
  • gray: Status is unknown.
  • green: Entity is OK.
  • yellow: Entity might have a problem.
  • red: Entity definitely has a problem.
Yes
accessible Connectivity status of the datastore. If this is set to false, the datastore is not accessible. Yes
url Unique locator for the datastore, if accessible is true Yes
fileSystemType Type of file system volume, such as VMFS or NFS Yes
name Name of the datastore Yes
nas.remoteHost Host that runs the NFS/CIFS server Yes
nas.remotePath Remote path of NFS/CIFS mount point Yes

VSphereDatacenter

Name Description Enabled by default
datastore.totalUsedGiB Total used space in the datastores, in GiB Yes
datastore.totalFreeGiB Total free space in the datastores, in GiB Yes
datastore.totalGiB Total size of the datastores, in GiB Yes
cpu.cores Total CPU count per datacenter Yes
cpu.overallUsagePercentage Total CPU usage, in percentage Yes
cpu.overallUsage Total CPU usage, in MHz Yes
cpu.totalMHz Total CPU capacity, in MHz Yes
mem.usage Total memory usage, in MiB Yes
mem.size Total memory, in MiB Yes
mem.usagePercentage Total memory usage as percentage Yes
clusters Total cluster count per datacenter Yes
resourcePools Total resource pools per datacenter Yes
datastores Total datastores per datacenter Yes
networks Total network adapter count per datacenter Yes
overallStatus
  • gray: Status is unknown
  • green: Entity is OK
  • yellow: Entity might have a problem
  • red: Entity definitely has a problem​
Yes
hostCount Total host system count per datacenter Yes
vmCount Total virtual machines count per datacenter Yes

VSphereResourcePool

Name Description Enabled by default
cpu.TotalMHz Resource pool CPU total capacity, in MHz Yes
cpu.overallUsage Resource pool CPU usage, in MHz Yes
mem.size Resource pool total memory reserved, in MiB Yes
mem.usage Resource pool memory usage, in MiB Yes
mem.free Resource pool memory available, in MiB Yes
mem.ballooned Size of the balloon driver in the resource pool, in MiB Yes
mem.swapped Portion of memory, in MiB, that is granted to this resource pool from the host's swap space Yes
vmCount Number of virtual machines in the resource pool Yes
overallStatus
  • gray: Status is unknown.
  • green: Entity is OK.
  • yellow: Entity might have a problem.
  • red: Entity definitely has a problem.
Yes
resourcePoolName Name of the resource pool Yes
datacenterName Name of the datacenter Yes
clusterName Name of the cluster Yes

VSphereCluster

Name Description Enabled by default
cpu.totalEffectiveMHz Effective CPU resources, in MHz, available to virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines. Yes
cpu.totalMHz Aggregated CPU resources of all hosts, in MHz. It does not filter out cpu used by system or related to hosts under maintenance. Yes
cpu.cores Number of physical CPU cores. Physical CPU cores are the processors contained by a CPU package. Yes
cpu.threads Aggregated number of CPU threads Yes
mem.size Aggregated memory resources of all hosts, in MiB. It does not filter out memory used by system or related to hosts under maintenance. Yes
mem.effectiveSize Effective memory resources, in MiB, available to run virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines. Yes
effectiveHosts Total number of effective hosts. This number exclude hosts under maintenance. Yes
hosts Total number of hosts Yes
overallStatus
  • gray: Status is unknown.
  • green: Entity is OK.
  • yellow: Entity might have a problem.
  • red: Entity definitely has a problem.
Yes
datastoreList List of datastore used by the cluster. A pipe or vertical bar character (|) is used as a separator. Yes
hostList List of hosts belonging to the cluster. A pipe or vertical bar character (|) is used as a separator. Yes
neworkList List of networks attached to the cluster. A pipe or vertical bar character (|) is used as a separator. Yes

For more help

Recommendations for learning more: