Configuring Citrix Virtual Desktop Infrastructure monitoring

The Monitoring Agent for Citrix Virtual DesktopInfrastructure monitors the following functions: Citrix XenDesktop component, Event log and alerts, and Citrix XenDesktop services. Additionally, you can view the Load Index Summary metrics performance data for Citrix XenApp and XenDesktop. You can diagnose problematic login times by viewing the performance data for the login steps.

Before you begin

• Make sure that the system requirements for the Citrix VDI agent are met in your environment. For the up-to-date system requirement information, see the Software Product Compatibility Reports (SPCR).
• Ensure that the following information is available:
  • Hostname of the delivery controller to which you plan to connect.
  • OData username, password, and domain.
  • PowerShell username, password, domain, PowerShell port, SSL verification type, and authentication mechanism if you enable Windows Event Log Event and PowerShell metric retrieval.
• Ensure that an agent operator user account has at least Citrix read-only administrator privileges. See Enabling Citrix read-only administration privileges.
• Starting with Citrix VDI agent version 8.1.3.1, the ability to retrieve Windows Event Log Events became available. To retrieve Windows Event Log Events from all Desktop Delivery Controller (DDC) and Virtual Delivery Agent (VDA) machines, remote PowerShell access needs to be enabled for the user account that is specified during the agent instance configuration. Follow these steps to ensure that the agent can run this function:
  1. Log in to a Windows computer as the user specified in the agent instance configuration.
  2. Run the following PowerShell command, where <vda_system> is the name of a VDA machine that is powered on: Get-WinEvent -FilterHashtable @{ProviderName='Citrix';LogName='Citrix';StartTime=((Get-Date).AddDays(-10))} -ComputerName vda_system

• Ensure that the following load-balancing policies are enabled for the monitored environment:

  • CPU Usage
  • Disk Usage
  • Memory Usage

  These policies can be configured through the Citrix Studio application.

About this task

The Citrix VDI agent is a multiple instance agent. You must create at least one instance, and start the agent instance manually.

The configuration for XenApp servers is the same as for XenDesktop servers. If a configuration parameter name or description mentions only XenDesktop, it is also for XenApp.

Procedure

1. Configure the agent on Windows® systems with the IBM Performance Management window or the silent response file.

   • Configuring the agent on Windows® systems
   • Configuring the agent by using the silent response file

2. Configure the agent on Linux® systems with the script that prompts for responses or the silent response file.

   • Configuring the agent by responding to prompts
   • Configuring the agent by using the silent response file

What to do next

Log in to the IBM Cloud Pak console to view monitoring data.

If you are unable to view the data in the agent dashboards, first check the server connection logs and then the data provider logs. The default paths to these logs are listed here:

• Linux®:

  /opt/ibm/apm/agent/logs
  

• Windows®:

  C:\IBM\APM\TMAITM6_x64\logs
  

  {:codeblock

• Configuration parameters for the Citrix VDI agent
• Configuring the agent on Windows® systems
• Configuring the agent by responding to prompts
• Configuring the agent by using the silent response file
• Enabling Citrix read-only administrator privileges
• Enabling monitoring of Windows® events and PowerShell metrics