Product Documentation

Manage: Overview

Oct 16, 2015

EdgeSight Agents

The EdgeSight Agent is a service that runs on an end-user device, virtual desktop, or XenApp Server and collects data, which it writes into a client-side database. The agent collects data, aggregates the data into a payload, and sends the payload to the EdgeSight Server. The following types of agents are available.

  • EdgeSight for Endpoints Agent - Endpoint agent software is designed for the user desktop or laptop environment. The agents operate continuously and discreetly on user systems collecting performance, resource, application and network data. The data is collected and stored in a local database and uploaded to an EdgeSight Server on a scheduled basis. Data can also be displayed directly from an agent database for use in problem resolution.
  • EdgeSight for Virtual Desktops Agent - Virtual desktop agent software is designed to monitor virtual desktops based on XenDesktop 4.0 or later. In addition to monitoring system, application, and network performance, it collects ICA channel data including XenDesktop multi-media counters, collects end user experience metrics, and alerts on XenDesktop session performance. Note that this agent does not provide monitoring of the Desktop Delivery Controller (DDC).

    Agents store data in a remote database and file share, with the EdgeSight Server acting as a database broker.

  • EdgeSight for XenApp Agent - XenApp agent software is designed for use on XenApp Servers. Data is collected and stored in a local database and uploaded to an EdgeSight Server twice a day. Data can also be displayed directly from an agent database for use in problem resolution. There are two levels of EdgeSight for XenApp Agent:
    • Basic agents require only that you have a XenApp Enterprise license available on your Citrix License Server. The agent records information about client and server performance and application usage.
    • Advanced agents provide the fully featured version of EdgeSight for XenApp and require that you have either a XenApp-Platinum Edition license or an EdgeSight for XenApp license available on your Citrix License Server. The agent records information about user sessions, client and server performance, application usage, and network connections.

EdgeSight Server

The EdgeSight Server collects data from the distributed agents and allows administrators to display the data to identify potential issues in the enterprise and to assist in problem resolution. The following components make up the EdgeSight Server:

  • Web Server - The web server component accepts the data uploads from the agents and then displays performance and availability information in a wide range of standard reports through the EdgeSight Server Console.
  • Database Server - The database server component stores the data uploaded from the agents and acts as the data source for Reporting Services.
  • Report Server - The report server component generates performance and availability information in the form of reports. The report server uses Microsoft SQL Server Reporting Services.

In an environment where EdgeSight for Endpoint Agents are monitoring virtual desktops in a pool, additional components are required:

  • EdgeSight Agent Database Server - This provides data storage for agents running on virtual desktops in a pool. The EdgeSight Web Server includes database broker components from which agents acquire a connection to an agent database server. The database broker components are installed by default.
  • Agent data file share - The agent data file share provides storage for files such as log files and INI files which are not stored on the EdgeSight Agent Database Server.

EdgeSight Server Console

Administrators interact with the EdgeSight Server through the EdgeSight Server Console. The console provides a powerful and flexible tool for displaying availability and performance information from the data collected by the distributed agents. To access the console, open a web browser to the URL for the EdgeSight Server and providing credentials on the logon page. An administrator can access the console using the following URL:


The EdgeSight Server Console has the following components.

  • Tabs - Use the tabs at the top of the content area to select the type of data you want to display or operation you want to perform. Most of the information in this guide pertains to the Configuration tab. The tabs are as follows:
    • Getting Started - This tab provides overview information for each tab. Click on each tab name to display descriptions of tab features. A checkbox allows you to disable the display of this tab on your subsequent logins.
    • Monitor - This tab allows you to perform real-time monitoring of performance counters on specified devices and to display information on alert conditions.
    • Troubleshoot - This tab allows you to perform real time troubleshooting using troubleshooting tools and real time reports. The real time reports display data directly from an agent database.
    • Plan and Manage - This tab allows you to display summary reports which provide an overview of your environment. Summary information can be displayed for devices, XenApp servers, users, processes, Websites, or transactions.
    • Track Usage - This tab allows you to display reports on usage of Citrix licenses, on published application launches and users, and on session duration.
    • Browse - This tab allows you to browse or search lists of reports and to display reports. You can also display report properties and subscriptions.
    • Configure - This tab allows you to edit your user profile, configure companies (including agent options, alerts, devices, and security), configure the server (including licensing, authentication, database grooming, and company creation), and monitor server status (including messages, jobs, services, and agent database broker activity).
  • Menu Bar - Use the Menu Bar at the top of the content area to perform common operations on the current page, such as adding a page to your list of favorites, refreshing a page, or printing a page. When displaying a report, you can add the report to the list of favorite reports or subscribe to the report.
  • Filter Bar - Once a report is selected, use the Filter Bar to filter report data. Depending on the report selected, filter by department, group, time period, process, device, user, site, and other data types. Filter data to isolate information based on particular classes of processes, devices, or users and to quickly identify problems or trends. You can also filter data on non-report pages such as the Current Alert List or the administrative and configuration pages. Click Go to apply filter parameters.
  • Help Link - Click the Help link at the top right of the console to invoke context-sensitive online help. In addition to context-sensitive help, the help system also provides reference material, such as a glossary of report metrics and a definition of SQL views.

License Server

Citrix Licensing 11.6 or later is used to supply licenses authorizing EdgeSight Agents to upload data to an EdgeSight Server. The license server can be anywhere on the network as long as it can be reached from the web server component of the EdgeSight Server and by the XenApp Agents. A single license server can be shared by multiple Citrix products, including multiple EdgeSight Servers.

Note: The license server and the EdgeSight license files should be in place before deploying EdgeSight in order to avoid delays in uploading data.

Separate licenses for XenApp Agents and Endpoint Agents must be obtained, even if both types of agents are associated with the same server. All agent license files (for example, CESEP_*.lic) must be placed in the MyFiles folder of the license server directory on the EdgeSight Server.

For more information on EdgeSight for XenApp licensing, see

EdgeSight Components Required for Virtual Desktop Monitoring

When using EdgeSight to monitor virtual desktops where data is not persisted across reboots, additional components are required for storing agent data. The following figure shows the relationship between these components and the systems being monitored:

Conceptual illustration of component relationship to monitored systems

The components required for virtual desktop monitoring include the following:

  • EdgeSight Server - Each EdgeSight Server installation includes database broker and database monitor components which supply database connection information to EdgeSight agents running on virtual desktops in a pool and listen for EdgeSight Agent Database Server registration and status.
  • EdgeSight Agent Database Servers - The database servers store data collected by EdgeSight agents running on virtual desktops. The database monitor on each server communicates with EdgeSight Server to announce its availability and update status at regular intervals.
  • Agent Data File Share - The file share stores agent files which are not stored in the EdgeSight Agent Database Server, such as log files and INI files.
  • EdgeSight Agents - The EdgeSight Agents collect performance data for the virtual desktops or systems on which they are installed. During agent installation, you specify which EdgeSight Server is to supply database connection information and the path to the agent data file share.

The EdgeSight components function within a larger environment which includes Citrix Provisioning Server and may include XenServer.

For more information on using the EdgeSight Server Console to monitor the status of pools, agent database servers, and database broker messages, see Displaying Agent Database Broker Status.