VMware Advanced Monitoring for Horizon powered by ControlUp - Horizon API Integration Demo

In this quick walkthrough we're going show you how to use the Horizon API integration and related dashboards, metrics and actions of ControlUp Advanced Monitoring for Horizon.

Overview


  • Section 1: Connect to all monitored resources.
  • Section 2: Focus on the TestDrive-vmwtd.com folder.
  • Section 3: Expand the "EUC Environments" folder in the Tree View.
  • Section 4: Explore the Horizon Connection Server Dashboard and related metrics.
  • Section 5: Explore Horizon Desktop Pools Dashboard and related metrics .
  • Section 6: Explore Horizon Desktop Pods Dashboard and related metrics.
  • Section 7: Explore Horizon Machines Dashboard and related metrics.
  • Section 8: Explore Horizon Session Dashboard and related metrics.

Before you Begin


In order to complete this product walkthrough please make sure you have the following:

  • A valid account in the VMware TestDrive environment, sign up here if you do not have one.
  • TCP & UDP ports 80, 443, 8443; and if using PCoIP, both TCP & UDP 4172
  • Latest Horizon Client installed, available via direct download here.
  • A ControlUp user account on TestDrive. See this article for info on how to access ControlUp on TestDrive and create an account. 

Version 8.1 of ControlUp allows VMware Horizon integration by monitoring and collecting metadata directly from Horizon API. This allows ControlUp to display real-time Horizon specific information.

Native API integration with VMware Horizon enables customers to add Horizon environments to the ControlUp Console in a few clicks, including:

  • Automatic discovery of Horizon components in both standard and Cloud Pod architecture.
  • Seamless association of Horizon components with entities from different data sources such as hypervisors and in-guest agents for complete line-of-sight from infrastructure to process.
  • Connection server health status & license monitoring.
  • Enhanced session monitoring with Horizon performance metrics.
  • Horizon-focused presets for Horizon Pods, Connection Servers, Pools, Machines, and Sessions views.
  • Enhanced Horizon environment management capabilities include new Horizon specific:
    • Built-in actions
    • Security policy permissions
    • Script Actions
    • Automated Actions
    • Enhanced Virtual Expert rules and recommendations

SECTION 1: Connect to all monitored resources.

Right Click on the TestDrive-vmwtd.com folder in the left pane, then select "Connect" in the context menu to connect to all the monitored resources.

TestDrive-Connect.png

 Section 2: Focus on the TestDrive-vmwtd.com folder.

In the left pane, right click on the upper most folder that is titled "TestDrive-vmwtd.com" and select "Focus" in the context menu.

TestDrive_FocusonTestDrive-vmwtd.com.png

 

Section 3:  Expand the "EUC Environments" folder in the Tree View.

On the left hand side of the screen in the Tree View, click the "+" next to the "EUC Environments" folder.

TestDrive_ExpanEUCEnvironments.png

Next, click the "+"sign next to the "Dallas Horizon" folder.

TestDrive_ExpandDallasHorizon.png

 You should now see a "Connection Servers" Folder and a "Desktop Pools" folder.

TestDrive_ConnectionServers_DesktopPools.png

 

Section 4: Explore the Horizon Connection Server Dashboard and related metrics.

Right click on the "Connection Servers" folder and select "Focus".

TestDrive_FocusonConnectionServers.png

Now you should see the Dashboard view on the right change. In the middle of the screen highlighted in blue you should see "Focusing on "TestDrive-vmwtd.com\EUC Environments\Dallas Horizon\Connection Servers' ".

At the top right under "Column Preset" the choice "Horizon Connections Servers" should be automatically selected. You will notice that the dashboard grid view in the center is showing only the Horizon Connection Servers, and includes a variety of Connection Server and Horizon Specific metrics.

TestDrive_ConnectionServersView.png

Click and drag the scroll bar at the bottom of the screen to the right. You will see there are quite a few Horizon specific metrics available in this dashboard view.

TestDrive_ConnectionsServerMetrics.png

The following metrics are included in the Horizon Connection Servers dashboard view.

HZ Connection Server Health Status - Horizon Connection Server Health Status

HZ Connection Server Enabled - Indicates the Horizon Connection Server is enabled.

HZ Connection Server Active Connections - Total number of user sessions connected through the Horizon Connection Server.

HZ Total Composer Machine Connections - The number of Horizon composer machine connections to this Connection Server.

HZ External URL - The External URL used by Horizon clients to establish a secure tunnel to the Connection Server instance.

HZ Connection Server Certificate Valid - Horizon Connection Server certificate status.

HZ Certificate Expiration Date - HZ Connection Server certificate expiration date.

HZ Is Licensed - Indicates whether the HZ Connection Server is Licensed.

HZ License Expiration Date - Expiration date of the HZ instance.

HZ License Mode - HZ License Mode used (applicable only for Connection Server machines).

HZ License Usage Model - The license usage model for this license (applicable only to Connection Server machines).

HZ Desktop Launching Enabled - Indicates whether Desktop Launching is enabled (applicable only to Connection Server machines).

HZ Help Desk License Enabled - Indicates whether Help Desk License is enabled.

HZ Instant Clone License Enabled - Indicated whether Instant Clone license is enabled (applicable only to Connection Server machines).

HZ View Composer Licensed Enabled - Indicates whether View Composer License is enable (applicable only to Connection Server machines).

HZ Application Launching License Enabled - Indicates whether Application Launching License is enabled (applicable only to Connection Server machines).

HZ Connection Server Version - HZ Connection Server Version.

HZ POD - HZ POD Name (Cloud POD Architecture Only).

HZ Site - HZ Site Name (Cloud POD Architecture Only).

 

Section 5: Explore Horizon Desktop Pools Dashboard and related metrics.

Next, in the tree view on the left, right click on "Desktop Pools"and select "Focus".

TestDrive_FocusonDesktopPools.png

 

Now you should see the Dashboard view on the right change. In the middle of the screen highlighted in blue you should see "Focusing on "TestDrive-vmwtd.com\EUC Environments\Dallas Horizon\Desktop Pools ". Click on "Folders".

TestDrive_DesktopPools_Folders.png

At the top right under "Column Preset" the choice "Horizon Pools" should be automatically selected. You will notice that the dashboard grid view in the center is showing only the Horizon virtual machines, and includes a variety of Horizon machine specific metrics.

TestDrive_HorizonDesktopPoolsView.png

 The following metrics are included in the Horizon Pools dashboard view.

 HZ Machines Source - HZ Machines Source.

 HZ Pool Type - Type of Desktop Pool.

 HZ Desktop Pool Availability - Indicates whether the Horizon Desktop Pool is available.

HZ Pool Enabled - Determines if the Desktop Pool is enabled.

HZ Provisioning Enabled - Determines if the HZ Provisioning is enabled.

HZ Machines - Total number of Horizon Machines.

HZ % Available Machines - Percentage of available Horizon machines.

HZ User Sessions - Total number of Horizon user sessions. 

HZ Problematic Machines -  The total number of machines that have a problem.

HZ Disconnected Sessions - The total number of disconnected sessions.

HZ Machines in Use - The total number of machine sis use by users (connected and disconnected).

HZ Last Provisioning Error - String message detailing the last provisioning error on this desktop while stopProvisioningonerror is enabled.

HZ User Assignment - User assignment scheme (floating or dedicated).

HZ Default Display Protocol - The default display protocol for the desktop.

HZ Automatic Logoff Policy - Automatic logoff policy after disconnect.

HZ Associated vCenter URL - URL of associated vCenter for this desktop.

HZ Operating System - Guest operating system. Applicable only for automated desktops.

HZ Supported Domains - Supported domains for the desktop. Applicable only for automated desktops.

HZ Power Policy - Power policy for the machines in the desktop after logoff. (This setting is only relevant for Horizon managed machines.)

HZ Image Quality - This setting determines the image quality that the flash movie will render. Lower quality results in less bandwidth usage.

HZ Automatic Logoff Timeout - The timeout in minutes for automatic logoff after disconnect.

HZ vRAM Size - The VM vRAM size in MB dedicated for managed 3D rendering. More vRAM can improve 3D performance.

HZ Instant Clone Current Image State - The state of the current image. (Applicable only for instant clone pools.)

HZ Instant Clone Pending Image State - The state of the pending image. This will be null when there is no pending image for the desktop. (Applicable only for instant clone pools.)

HZ Last Modified - Desktop Pool last modification time.

Horizon Pool Specific Actions -

Click on the Column labeled "HZ Desktop Pool Availability" to sort by the field to see which Pods are available and not available. Right click on any Pod (under the "Name" column), then select "Horizon Management". A new context menu pops up, giving you the choice to either enable or disable (depending on the current state) the Horizon Pool or Horizon Pool Provisioning.

TestDrive_HorizonPools_Actions.png

Section 6: Explore Horizon Desktop Pods Dashboard and related metrics.

In the top right of the screen beneath Column Preset, click the dropdown box and select "Horizon Pods".

TestDrive_ColumnPreset_HorizonPODs.png

In this view, you will see a number of Horizon specific metrics.

TestDrive_HorizonPods_Metrics.png

Here are the Horizon specific metrics in the Horizon Pods dashboard.

 HZ Site - HZ Site Name (Cloud POD Architecture Only).

HZ Desktop Pools - The total number of desktop pools.

HZ Available Machines - The total number of machines in the "Available" state.

HZ % Available Machines - Percentage of available Horizon machines.

HZ Problematic Machines -  The total number of machines that have a problem.

HZ Machines in Use - The total number of machine sis use by users (connected and disconnected).

HZ User Sessions - Total number of Horizon user sessions. 

HZ Disconnected Sessions - The total number of disconnected sessions.

HZ Healthy Connection Servers - The total number of healthy connection servers.

HZ Available Desktop Pools - The total number of available desktop pools.

HZ % Available Desktop Pools - Percentage of Available desktop pools.

HZ Connection Servers - The number of connection servers.

 

Section 7: Explore Horizon Machines Dashboard and related metrics.

In the top middle of the screen, click on the "Machines" object. When the view changes, you should see "Horizon Machines" in the top right under the "Column Preset"

TestDrive-HorizonMachines_Preset.png

Here are the Horizon specific metrics in the "Horizon Machines" view.

HZ Pool Name - For the Horizon Machine, the name of the Horizon Desktop Pool.

HZ State - The basic state of the machine.

HZ Power State - The virtual machine power state.

HZ Maintenance Mode - Horizon Maintenance mode state. True if the machine is in Maintenance mode.

HZ Managed - If the machine is a Horizon managed virtual machine or an unmanaged stand alone.

HZ Assigned User - The use assigned to the machine. This cannot be a group. 

HZ Agent Version - Horizon Agent version.

HZ Create Time - The time the machine was created. Applies only to Horizon managed machines.

 Horizon Machine Specific Actions -

Due to the locked down security policies required by TestDrive, your ID may not have this capability. Right click on any Horizon session (in the "Name" column). In the context menu that pops up, scroll down and select "Horizon Management".  You should see three options in the content menu that opens up -

  • Disconnect session
  • Logoff session
  • Logoff session forcibly

 Section 8: Explore Horizon Sessions Dashboard and related metrics.

 In the top middle of the screen, click on the "Sessions" object. When the view changes, you should see "Horizon Sessions" in the top right under the "Column Preset"

TestDrive_HorizonSessionsDashboard.png 

Here are the Horizon specific metrics in the "Horizon Sessions" view.

HZ Pool Name - The name of the Horizon Desktop Pool.

HZ Session Type - The type of Horizon session.

HZ Session Start Time - Time when this session was originally logged in.

HZ Last Session Duration - Duration of the last connection period of the session.

HZ Desktop Source - Desktop source if this is a desktop session. Unset otherwise.

HZ Client version - Horizon client version for this session. 

HZ Client Domain -  In Horizon, the AD Domain of the workstation running the Horizon client.

HZ Connection Server URL - In VMware Horizon, the URL of the Connection  Server to which the Horizon client is attached.

HZ Security Gateway IP Address - IP Address of the Unified Access Gateway.

HZ Security Gateway Name - The machine hostname or DNS name of the Unified Access Gateway.

HZ POD - HZ POD Name (Cloud POD Architecture Only).

HZ Site - HZ Site Name (Cloud POD Architecture Only).

Horizon Session Specific Actions -

Due to the locked down security policies required by TestDrive, your ID may not have this capability. Right click on any Horizon session (in the "Name" column). In the context menu that pops up, scroll down and select "Horizon Management".  You should see three options in the content menu that opens up -

  • Disconnect session
  • Logoff session
  • Logoff session forcibly

TestDrive_HorizonSessions_actions.png

 

 

 

Have more questions? Submit a request

Article is closed for comments.