View Source

h6. Contents

This page references the GroundWork Cloud Hub and the VMware virtualization environment.

h4. 1.0 Managing a VMware Connection

This section reviews how to add and configure the Cloud Hub connector VMware. Each connector requires a unique set of parameters (e.g. URI, credentials). You will need your GroundWork server and virtual environment connector parameters handy.

h5. 1.1 Adding a new connection

# Log in to GroundWork Monitor as an *Administrator*.
# Select *GroundWork Administration* > *GroundWork Cloud Hub*. The *Cloud Hub Configuration Wizard* screen will be displayed where you can add and configure the Cloud Hub for various virtual environments. For each of the established configurations you can start or stop the connection, modify the parameters, or choose to remove a connection.
# To start a new connection click the *\+Add* icon next to the environment to add. You will create a new connector in this way for each region in *VMware* that is to be monitored.
Figure: Cloud Hub Configuration Wizard

h5. 1.2 Configuring GroundWork server values

# Next, enter the GroundWork server values to access the region. You will need to point the Cloud Hub VMware connector to a GroundWork server, indicate if it supports SSL, and give it an API key to transmit data.
Figure: GroundWork server values for VMware (Example)
#* *Display Name*: This is the configuration server display name.
#* *GroundWork Server Name*: You will need to enter the name of the GroundWork server that will integrate the Cloud Hub messages. If Cloud Hub is running on the same server as the portal the name can be *localhost*, or as preferred the server name.
#* *Is SSL enabled on GroundWork Server?*: Check this box if the GroundWork server is configured for secure HTTPS.
#* *GroundWork Web Services Username and Password*: User and password configured to access the Web Services API. These can be obtained by opening a tab to the GroundWork Administration > GroundWork License page. These are the same credentials set within {{*/usr/local/groundwork/config/{*}}}.
{note}* *Important for LDAP enabled systems*: Make sure that it matches with the entry in the {{{*}{*}}} file and the user is member of the Authenticated group and the WSUser (or GWUser) group in LDAP.
* *Without 7.0.2 SP3*: The Web Services user name may be different if you are using LDAP and GroundWork Monitor 7.0.2 without the SP3 patch. In this case make an adjustment to what you see in the image below to match what you have, and also fill in the accurate password.
* *With 7.0.2 SP3*: If you applied the SP3 patch the Web Services user will not have a password, instead you need to fill in the token from the _GroundWork Administration_ > _GroundWork License_ page. Under the title _Webs Services API Account Info_ the default encrypted token can be copied into the Cloud Hub page.{note}
#* *Merge hosts on GroundWork Server?*: If checked, this option combines all metrics of same named hosts under one host. For example,  if there is a Nagios configured host named _demo1_ and a Cloud Hub discovered host named _demo1_, the services for both configured and discovered hosts will be combined under the hostname _demo1_ (case-sensitive).

h5. 1.3 Configuring virtualization server values

# Next, we continue with the second half of the configuration wizard by entering the values for the virtualization server. The data that the GroundWork server receives comes from the VMware server, the information is pulled from the API on a periodic basis based on the check interval that is set. You can also select which views to include. 
Figure: Values for a VMware connection (Example)
#* *Is SSL enabled on VMware Server?*: Check this box if the VMware server is configured for secure HTTPS.
#* *VMware Server Name*: This is the name of the VMware server and the domain name, (e.g. **)
#* *VMware Server URI*: This is the server URI, (e.g. *sdk*)
#* *VMware Server Username and Password*: This is the VMware server user name and password, (e.g. *esxuser*)
#* *Check Interval (in mins)*: This is the polling interval for collecting monitoring data from the virtual instance and sending it to the GroundWork server. The value is in minutes.
#* *Connection Retries (-1 infinite)*: This entry is the number of retries for the connection and sets a limit on how many attempts are made after a failure. If you set this to \-1 the retrying goes on forever. The number set indicates how many connections are attempted before the connection is left inactive (until you restart it).
#* *Views*: The three radio buttons specify the views you would like to report, *Hyperviser View* , *Storage View*, *Network View*, and *Resource Pool View*.
# Select *SAVE* which saves the current connection values and writes the entries to an XML file in the GroundWork server */usr/local/groundwork/conifg/cloudhub* directory. When you choose to save the Cloud Hub connector is assigned an agent ID and that in turn becomes a record locator in Foundation when you begin monitoring.
# Then to validate the configuration select *TEST CONNECTION* which will check if the virtual instance is accessible with the given credentials. If successful you should see *Connection successful\!* at the top of the screen.
# After the credentials have been validated select *NEXT* to display an associated connection metrics screen where you can determine the metrics to be monitored for VMware, (the *HOME* option would take you back to the first page of the configuration wizard).

h5. 1.4 Determining metrics to be monitored

Each management system provides metrics for specific checks that can be defined for the instance or the container. The property name and the thresholds are defined in a monitoring profile in an XML format. 

The VMware API (application programming interface) defines a set of metrics (measurements regarding performance, resource utilization, bandwidth) that apply to hypervisors (physical machines), hosts (virtual machines), networks and datastores (disk partitions). The metrics gathered by Cloud Hub are of two kinds: *native* and *synthetic*. The strings that define the native metrics are exactly those supported by the VMware API, with certain restrictions, namely that the list must be from those metrics that result in values, and not lists of objects. The majority of the metrics are numeric in nature - amounts of "MHz" (megahertz, in VMware parlance), amounts of memory (bytes, megabytes), amounts of disk space (bytes, megabytes, gigabytes). Again, they are taken in their native form, neither normalized nor adjusted.

The *native metrics* lack a sense of normalization, as an example a host (VM/virtual machine) may have a metric for CPU utilization of "273". The _VMware_ documentation indicates that this value is in MHz (megahertz). However, in ferreting out system issues, it is often more useful to know what proportion of the total resource in question is in use. In other words, "273 of what?"

The *synthetic metrics* are pairs of native metrics, cast into _percentage-of-total_ form. The numerator (number "on top") is a performance metric, and the denominator (divisor "on the bottom") is the "sum of, or size of a resource". Synthetic metrics can be extremely helpful in deciphering performance and accessibility issues in real-time. The percentages are bounded in the \[0..100\] range, and they include the "%" character at the end.
# The metrics screen allows you to define if a metric should be monitored and graphed, and lets you set the values for Warning and Critical thresholds at which to trigger alerts. It is recommended to use the synthetic metrics (computed percentages) since it helps to define the threshold values in a 0-100% range:
#* *Attribute*: The name of the service attribute (the metric name reported by the virtualization server).
#* *Monitored*: When on (checked) the service will be monitored.
#* *Graphed*: When on (checked) the service will be graphed.
#* *Warning and Critical Thresholds*: These values control the triggering of alerts. A *Warning* number larger than the *Critical* value will cause Cloud Hub to detect the metric as a trigger. Choosing a {{*\-1{*}}} in a threshold box will disable triggering on that alert.
#* *Service Name*: CloudHub automatically creates service names based on the metric name gathered from a virtualization server. The Service Names option adds the ability to report the polled metrics under a unique name that is set by the administrator. Leaving the Service Name field blank defaults to the metric name reported by the virtualization server. All CloudHub connectors now support the editable Service Name feature.{note}If a Service Name is added for an attribute, along with the Graphed option on (checked), a performance graph will need to be configured for the new service name. You can easily do this by copying and editing the original performance graph entry. Go to Configuration > Performance, from the Select Service-Host entry drop-down list select the original service name, select Copy, and in the Service field replace the entry with the new service name you entered in Cloud Hub, select Create Copy. After a couple minutes the graph should display in Status.{note}
#* *Description*: A description of the service attribute.
# When you are satisfied with the profile selections choose *SAVE* to write out the profile. Select *HOME* to return to the main Cloud Hub panel.
{note}The view selections made on the previous screen will determine metric options. The image below shows all views.{note}\\
Figure: Cloud Hub Configuration wizard for VMware - Hypervisor thresholds, Virtual Machine thresholds, and Storage thresholds
# Select *START* for the specific connector to begin the discovery and data collection process.
Figure: Cloud Hub Configuration
\\ !bookshelf_cloud_hub_vmware_05.jpg|border=1!

h4. 2.0 Unified Monitoring

So how does all this get represented in the unified monitoring context? The data for the monitored services selected are passed to the GroundWork REST API and are directly inserted into the Status and Event Console tables in the GroundWork Foundation database which makes them show up in the UI almost immediately.

h5. 2.1 Status view

After starting the connection, in a couple minutes the Status viewer application will display the automatically created host groups corresponding to the views chosen in setup. The monitoring can be adjusted by returning to the Cloud Hub configuration screen and modifying metrics collected (check/un-check) or modifying threshold values.
* You will see names of the instances are prefixed with the string *ESX\_* to distinguish them as Cloud Hub VMware Connector items
* You may of course assign the discovered host groups to [Custom Groups|Custom Groups Configuration] (e.g Virtual, VMware) in order to organize the Status display

{color:#333333}In our example, we show the{color} {color:#333333}{*}syn.vm.mem.sharedToConfigMemSize{*}{color}{color:#333333} service Status Information as{color} {color:#333333}{*}WARNING{*}{color}{color:#333333}, {color}as this is reflective of the current threshold set in the profile. In this view you can also see the graphs coming in under *Service Availability and Performance Measurement*, and the events being logged at the bottom of the screen. 

Figure: Status view

h5. 2.2 Event Console

Here in Event Console, we have selected the system applications filter OS, which lists events for the VMware application type. From here you can select specific events and apply various actions.

Figure: Event Console, by Application Type (VEMA)

h5. 2.3 Dashboards

This view displays the Enterprise View dashboard and indicates the host ** status as Host Recently Recovered.
Figure: VMware Connections - Dashboards, Enterprise View
\\ !bookshelf_cloud_hub_vmware_08.jpg|border=1!

h5. 2.4 NoMa

Below we show the NoMa log for notifications in which you can see alerts for the service *syn.vm.mem.sharedToConfigMemSize*.
Figure: NoMa notification log

h4. 3.0 Monitoring Profile for the VMware Virtual Environment

The master monitoring profiles for virtual environments are stored on the GroundWork server. Each time the user goes into the configuration screens for Cloud Hub the monitoring profile from the GroundWork server would be loaded into the Cloud Hub. This allows to you to manage and maintain the monitoring profiles for Cloud Hub in a central location.

h5. 3.1 Location of profiles

The location for Cloud Hub monitoring profiles is:
Viewing the profiles directory:
{code}[root@gwdemo~]# cd /usr/local/groundwork/core/vema/profiles
[root@gwdemo profiles\]# ls
amazon_monitoring_profile.xml openstack_monitoring_profile.xml
docker_monitoring_profile.xml rhev_monitoring_profile.xml
netapp_monitoring_profile.xml vmware_monitoring_profile.xml
[root@gwdemo profiles]#{code}
The name of the VMware monitoring profile is:

If you wish, you may carefully edit *vmware_monitoring_profile.xml* to include additional numeric metrics.
{note}If you edit PLEASE test immediately. Any metric test that is slightly misspelled or otherwise rejected short-circuits ALL the metrics from reporting silently and without raising flags. In general, we can't recommend adding additional numeric metrics, at the time of this writing all useful metrics have been included as part of the released XML file contents.{note}

h5. 3.2 VMware monitoring profile: {{vmware_monitoring_profile.xml}}

{code}<?xml version="1.0" encoding="UTF-8"?>
<metric name="summary.quickStats.overallCpuUsage" description="Overall Hypervisor CPU Usage" monitored="false" graphed="false" warningThreshold="1500" criticalThreshold="2500" />
<metric name="summary.quickStats.overallMemoryUsage" description="Overall Hypervisor Memory Usage in MB" monitored="false" graphed="false" warningThreshold="3500" criticalThreshold="4500" />
<metric name="summary.quickStats.uptime" description="Hypervisor Running up time" monitored="false" graphed="false" warningThreshold="3500" criticalThreshold="4500" />
<metric name="" description="Hypervisor CPU Usage Percentage" monitored="true" graphed="true" warningThreshold="75" criticalThreshold="95" />
<metric name="" description="Hypervisor Memory Usage Percentage" monitored="true" graphed="true" warningThreshold="90" criticalThreshold="95" />

<metric name="summary.capacity" sourceType="storage" description="Total Capacity of Storage Device (bytes)" monitored="true" graphed="false" warningThreshold="-1" criticalThreshold="-1" />
<metric name="summary.freeSpace" sourceType="storage" description="Free Space on Storage Device (bytes)" monitored="true" graphed="true" warningThreshold="-1" criticalThreshold="-1" />
<metric name="summary.uncommitted" sourceType="storage" description="Uncommitted Bytes on Storage Device" monitored="true" graphed="false" warningThreshold="-1" criticalThreshold="-1" />
<metric name="" sourceType="storage" description="Percent Usage of a Storage Device" monitored="true" graphed="true" warningThreshold="-1" criticalThreshold="-1" />

<metric name="summary.quickStats.balloonedMemory" description="VM Ballooned memory in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.compressedMemory" description="VM Compressed memory in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.consumedOverheadMemory" description="VM Consumed Memory consumption in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.guestMemoryUsage" description="VM Guest Memory consumption in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.hostMemoryUsage" description="VM Host Memory Usage in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.overallCpuDemand" description="VM Overall CPU Demand" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.overallCpuUsage" description="VM Overall CPU Usage" monitored="false" graphed="false" warningThreshold="50" criticalThreshold="80" />
<metric name="summary.quickStats.privateMemory" description="VM Private Memory Used in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.sharedMemory" description="VM Shared Memory Used in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.ssdSwappedMemory" description="VM SSD Swapped Memory in MB" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.quickStats.swappedMemory" description="VM Swapped Memory in MB" monitored="false" graphed="false" warningThreshold="500" criticalThreshold="1000" />
<metric name="summary.quickStats.uptimeSeconds" description="VM Up time in seconds" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />

<metric name="summary.runtime.bootTime" description="VM Boot time in seconds" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.runtime.connectionState" description="VM Connection State" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.runtime.memoryOverhead" description="VM Memory Overhead" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />
<metric name="summary.runtime.powerState" description="VM Power State" monitored="false" graphed="false" warningThreshold="2000" criticalThreshold="3000" />

<metric name="" description="VM Storage Percent Committed" monitored="true" graphed="true" warningThreshold="60" criticalThreshold="80" />
<metric name="" description="VM Storage Percent UnCommitted" monitored="true" graphed="true" warningThreshold="2000" criticalThreshold="3000" />

<metric name="syn.vm.mem.balloonToConfigMemSize.used" description="VM Ballooned Memory Used Percentage" monitored="true" graphed="true" warningThreshold="50" criticalThreshold="75" />
<metric name="syn.vm.mem.compressedToConfigMemSize.used" description="VM Compressed Memory Used Percentage" monitored="true" graphed="true" warningThreshold="50" criticalThreshold="75" />
<metric name="syn.vm.mem.sharedToConfigMemSize.used" description="VM Shared Memory Used Percentage" monitored="true" graphed="true" warningThreshold="50" criticalThreshold="75" />
<metric name="syn.vm.mem.swappedToConfigMemSize.used" description="VM Swapped Memory Used Percentage" monitored="true" graphed="true" warningThreshold="75" criticalThreshold="90" />
<metric name="syn.vm.mem.guestToConfigMemSize.used" description="VM Guest Memory Used Percentage" monitored="true" graphed="true" warningThreshold="75" criticalThreshold="85" />
<metric name="syn.vm.cpu.cpuToMax.used" description="VM Cpu Usage Percentage" monitored="true" graphed="true" warningThreshold="75" criticalThreshold="95" />


h4. 4.0 Removing Connectors from Monitoring

If you decide you do not want to monitor a particular region, simply navigate to *GroundWork Administration* > *GroundWork Cloud Hub*&nbsp;select *STOP*&nbsp;for the connector, then&nbsp;*DELETE*. All of the created host groups and the discovered and monitored instances for that region will be deleted from the Foundation database within a few minutes and monitoring access to the region endpoint will cease.

Additionally, see How to remove Cloud Hub hosts in the document [How to delete or remove hosts].