Product Documentation

Install

Oct 16, 2015

Preparing to Install Citrix EdgeSight

Citrix® EdgeSight™ software includes the following components:

  • EdgeSight Server — Displays performance data for monitored devices.
  • EdgeSight for XenApp Agent — Monitors the performance of XenApp and Presentation Server systems. Multiple versions of the agent are provided to accommodate different XenApp versions.
  • EdgeSight for Endpoints Agent — Monitors the performance of physical clients.
  • EdgeSight for Virtual Desktops Agent — Monitors the performance of instances of XenDesktop 4.0 or later. This agent enables the following features:
    • Collection of ICA channel data including XenDesktop multi-media counters
    • Collection of End User Experience metrics
    • Alerting on XenDesktop session performance
  • EdgeSight Agent Database Server — Stores performance data for agents monitoring virtual desktops.
  • EdgeSight Active Application Monitoring (AAM) Components — Performs automated testing to monitor the end user experience of applications in XenApp and Presentation Server environments.

Citrix EdgeSight software is installed using Windows Installer (MSI) files. The EdgeSight Server MSI files are invoked using a bootstrapper program (setup.exe). The following table lists the MSI files by EdgeSight component. Separate MSI files are provided for 32-bit and 64-bit systems for EdgeSight Server and EdgeSight Agents.

EdgeSight Component MSI Name
EdgeSight Server (32-bit systems) EdgeSightServer.msi
EdgeSight Server (64-bit systems) EdgeSightServerx64.msi
EdgeSight for XenApp Agent for XenApp 6 (64-bit only, due to underlying operating system)
Note: Use this agent for monitoring XenApp 6 and XenApp 6.5 for Windows Server 2008 R2 systems.
EdgeSightXA6Agentx64.msi
EdgeSight for XenApp Agent (32-bit systems) EdgeSightXAAgent.msi
EdgeSight for XenApp Agent (64-bit systems) EdgeSightXAAgentx64.msi
EdgeSight for Endpoints Agent (32-bit systems) EdgeSightEPAgent.msi
EdgeSight for Endpoints Agent (64-bit systems) EdgeSightEPAgentx64.msi
EdgeSight for Virtual Desktops Agent (32-bit systems) EdgeSightVDAAgent.msi
EdgeSight for Virtual Desktops Agent (64-bit systems) EdgeSightVDAAgentx64.msi
EdgeSight Agent Database Server EdgeSightAgentDBS.msi
EdgeSight Active Application Monitoring components (Controller, Launcher, and Web Interface) EdgeSight Active Application Monitoring.msi
Citrix License Server CTX_Licensing.msi
Note: Do not modify the base MSI files. Modifying the base MSI files can interfere with support efforts in case of installation issues. You can customize the installation by specifying options and properties on the command line or by creating a transform.

Server Installation Overview

Use setup.exe to install an EdgeSight Web server and database server. After you install and configure the server components, deploy the applicable EdgeSight Agent to XenApp Servers, end-user systems, and virtual desktops. In addition to the software listed in “Server Requirements” in System Requirements for EdgeSight 5.4, EdgeSight Server requires the following software. It is highly recommended that you install the following software before installing EdgeSight Server software.

  • Microsoft SQL Server Reporting Services—required for the generation of historical reports. Reporting Services must be in place before reports can be generated and displayed. For information on configuring Reporting Services for use with EdgeSight software, see Managing: Overview.
  • Citrix Licensing—used to supply a license authorizing the agent to upload data to a Citrix EdgeSight Server. The license server can be installed anywhere on the network and can be shared by multiple EdgeSight servers. The license server and EdgeSight license files must be in place before data can be uploaded to the server. A Citrix License Server MSI is included with the EdgeSight media for your convenience. For more information and supported versions, see “Citrix Licensing Requirements” in System Requirements for EdgeSight 5.4.

When planning your installation, the required server components can be installed on separate physical machines. (The Web server can be installed on the same machine as the database server, but the machine should have at least two processors.) In all cases, ensure that the machines have sufficient memory and processor capabilities (as described in “Server Requirements” in System Requirements for EdgeSight 5.4) and that the machines are in the same domain.

The MSI file installs server files for both EdgeSight for XenApp and EdgeSight for Endpoints. Both products use the same underlying server technologies. You can enable or disable agent support for either product after installation.

Note: EdgeSight Server should not be installed on the same system as XenApp in a production environment, but this can be done to support a proof of concept environment.

Agent Deployment and Installation Overview

Use the applicable EdgeSight Agents MSI file to install EdgeSight agents on target machines. Separate MSI files are provided for each type of agent (EdgeSight for XenApp, EdgeSight for Virtual Desktops, and EdgeSight for Endpoints), for each target system architecture (32-bit and 64-bit), and for XenApp versions (Presentation Server / XenApp 5 and XenApp 6). The EdgeSight for XenApp Agent MSI file provides both the Basic and Advanced versions of the agent. You can deploy agents to end-user systems or XenApp Servers in your enterprise using several methods:

  • Direct command-line or GUI-based installations using the MSI file.
  • Define an Active Directory Group Policy Object for software distribution of the MSI file. Note that GPO push to users is supported.
  • Perform a System Management Server (SMS) issuance of the MSI file.

If you are installing the EdgeSight for Endpoints agent or the EdgeSight for Virtual Desktops agent on virtual desktops, additional software components and installation tasks are required, as described in Installing EdgeSight for Monitoring Virtual Desktops. Discuss your software deployment environment with your Sales Representative; they can assist you in implementing an effective means of deploying the agent.

Active Application Monitoring Installation Overview

EdgeSight Active Application Monitoring is an automated performance testing tool that periodically samples critical application transactions to monitor the availability and responsiveness of virtualized applications, providing insight into application performance and end-user experience.

EdgeSight Active Application Monitoring software includes the following components:

  • Citrix EdgeSight Controller—used to record and create virtual user scripts and define tests. When the test is ready for playback, the Controller instructs the Launchers to run the test for a specific period of time.
  • Citrix EdgeSight Launcher—receives commands from the Controller and generates virtual user ICA sessions on the target Presentation Servers and XenApp servers. The number of Launchers required will vary based on the target virtual user load.
  • Web Interface Connector—allows users to connect to applications made available through the XML Service. This feature requires the Visual J# Version 2.0 Redistributable Package available from Microsoft.

Launchers are installed on clients of the Servers that will be under test. They can be installed on systems with the Controller and as stand-alone launchers. See Installing EdgeSight Active Application Monitoring Software for installation procedures for these components.

Pre-Installation Considerations

Software running in your environment may need to be configured to allow Citrix EdgeSight software to operate properly. Review the following considerations and related actions and determine if they apply to your environment.

Agent

  • Proxy Servers and Settings—If the EdgeSight Agent will communicate with the EdgeSight Server through a proxy server, ensure that you have the proxy server IP address, port number, and credentials required prior to installing EdgeSight Agent. See Installing EdgeSight Agents for instructions on specifying proxy server information during agent installation.
  • Firewalls—If firewall software is resident on machines on which EdgeSight Agents will be installed, the listen port on the client machine (port 9035) must be open. This is the port on which the agent listens for remote connections from the browser displaying the EdgeSight console. There is an option during agent installation to automatically set a Windows Firewall exception for the listen port if the firewall is running (enabled or disabled). See Installing an Agent Using the User Interface for instructions on specifying the listen port number. Also see “Configuring Firewalls” in Configuring Third Party Software for information relating to personal firewalls.
  • Virus scanning software—If your environment uses virus scanning software, script blocking features must be disabled to allow the EdgeSight Agent to run scripts. Also, exclude agent data files from being scanned. See “Configuring Antivirus Software” in Configuring Third Party Software for detailed information on which files should be excluded from scans.

Server

  • Virus scanning software—If your environment uses virus scanning software, script blocking features must be disabled to allow EdgeSight Server to run scripts. Also, exclude the server database from being scanned. See “Configuring Antivirus Software” in Configuring Third Party Software for detailed information on which files should be excluded from scans.
  • IIS Security Lockdown template—Any IIS Security Lockdown templates must allow the IIS components listed in “Server Requirements” in System Requirements for EdgeSight 5.4 to run. Adjust the template as required.
  • Group Policy—Ensure that Group Policies do not prohibit any of the required software components from running on your EdgeSight Server. Also, ensure that policy changes that would prohibit software components from running are not scheduled for deployment after the installation is complete.
  • SQL Server 2005 Password Policy—SQL Server 2005 includes an option to enforce Windows password policy. This option is enabled by default and will cause an error if the passwords supplied for accounts during installation do not meet the necessary strength requirements. If an error occurs containing the text, “Password validation failed. The password does not meet Windows policy requirements because it is not complex enough,” then double check your password requirements, reattempt installation, and supply appropriately complex passwords.
  • SSL Certificate—If you choose to enable SSL for use on the Citrix EdgeSight Web server, you must either use an SSL certificate from a recognized certificate authority or a correctly generated and installed certificate from Microsoft Certificate Server to allow proper software operation. For detailed information, see How to Configure EdgeSight to use SSL with Microsoft Certificate Services. SSL certificates which do not meet these criteria do not allow remote pages to be displayed or remote scripts to be run. Attempts to perform these actions without a valid certificate result in an error message.

    Citrix Systems recommends the use of SSL (HTTPS mode) when accessing the EdgeSight Server Console. The use of HTTP mode is not recommended. Failure to use SSL can increase the risk of security breaches including, but not limited to, disclosure of sensitive information including passwords and session cookies, potential compromise of the administrator account, session hijacking, and arbitrary execution of commands.

    If it is not possible to get a standard CA-signed certificate for each server, the following approach may be taken. Install an organization-wide CA (CA-Org) which has a certificate of itself. This CA can now sign the public keys for all servers in the organization. When any client (browser) tries to connect to any of these servers over HTTPS, it will get a server certificate which is signed by CA-Org. For the browsers to be able to accept the server certificate and work seamlessly without giving any warnings, it is required that the certificate of CA-Org is accepted by all browsers. Either the certificate of CA-Org is signed by a standard CA like Verisign or GeoTrust which the browsers accept by default, or the self-signed certificate of CA-Org is pre-installed on all the browsers in the organization. In both the cases, the communication would be secure as long as the private key of CA-Org is not compromised.

  • SMTP Server—During installation, you must specify an SMTP server. It is important that a valid SMTP server name is used. EdgeSight Server uses the SMTP server for many operations, including the distribution of alert notifications, server error conditions, and new user passwords.