Server settings allow you to manage global settings on a Citrix EdgeSight Server. All server settings are located on the Configure tab under Server Configuration and Server Status. Server settings allow you to perform the following tasks:
The Status page () provides you with an overview of server operations across all companies. The Company table lists how many devices have and have not uploaded data to the server during the current day, by company. It also lists how many new devices running EdgeSight Agent have registered with the server for the current day and during the previous week. The status for messages, unmanaged devices, alerts, and crash reports simply provide a count indicating activity for the current day.
|Status Type||For detailed information...|
|Company||Navigate toto display details on when specific devices uploaded data to the server and to display information on new devices.|
|Server Script Host||Click Server Script Host Status to display the Server Script Host Status page. Navigate to and select the applicable tab to display and manage settings for Data Upload and Crash Processing.|
|Message Status||Click Message Status to display the most recent messages.|
|Unmanaged Devices||Click Unmanaged Devices to display information on unmanaged devices. An unmanaged device is a system with an EdgeSight Agent installed that is not associated with a company and department.|
|Alerts||Select the Monitor tab and then select either Alert Console or Alert List to display information about the most recent alert notifications.|
|Crash Reports||Select the Monitor tab and then select Alert List and filter for Process fault or Process snapshot alerts. See the Citrix EdgeSight User’s Guide for more information on accessing and using crash reports.|
The Settings page () allows you to control how EdgeSight Server handles the following capabilities:
In most cases, you will not need to adjust any of the values or settings on this page. We recommend that you use the default settings and observe server performance in production conditions before considering the adjustment of server settings.
Depending on the Citrix EdgeSight products installed in your environment, you may want to enable or disable the display of reports displaying data from XenApp servers or from endpoints. You may also want to select the level of support offered for EdgeSight for XenApp agents: Basic or Advanced.
This setting only determines whether reports and administrative pages are displayed on the console; data continues to be collected, uploaded, and stored even if display support is disabled. Note that unlike alert suppression settings, this is a server wide setting and affects what all users see when using the console. For more information on what tools and reports are displayed based on agent type, see EdgeSight Feature Availability.
To enable or disable support, choose an option from the support drop-down menus. If you select an option which excludes available data from being displayed, such as disabling XenApp agent support for a server which has EdgeSight for XenApp agents reporting up to it, a confirmation box is displayed.
If EdgeSight for Endpoints support is enabled, you can also edit the name and port of the Citrix License Server which supplies licenses for endpoint systems.
This Agent Database Broker tab allows you to enable the display of detailed broker log messages. This option is set to Off by default. If this option is enabled, additional status messages are displayed on the Broker History page. (See “Displaying Broker History” under for more information.) Detailed logging always occurs on the agent database broker; this feature simply controls the display of data on the Broker History page. This feature is useful for providing detailed information when debugging agent database broker issues.
The SMTP server name and email addresses are specified during server installation, but can be changed as required.
The following table defines the notification options. The email options enable the server to send email to the EdgeSight Administrator Email Address in the event of agent or server errors.
|New Agents||This option is recommended as an effective means of notifying an administrator by email that new devices will be uploading data to the server. Client registration is controlled by company-specific settings as described in "Managing Company Properties".|
|Agent Errors||You may want to enable this option when first using Citrix EdgeSight Server to help detect and resolve agent property issues. This option may not be necessary once these issues have been resolved. In most cases, agents are able to automatically recover from errors.|
|Server Errors||You may want to enable this option when first using Citrix EdgeSight Server to help detect and resolve configuration issues. This option may not be necessary once these issues have been resolved.|
|Communication Errors||This option is recommended as an effective means of alerting an administrator to device communications problems.|
|Send an email when there is bad HTTP read of a payload (not recommended)||This option is not recommended for normal use because uploading of payloads is retried as required. You may want to enable this option for use in debugging a specific problem uploading payloads.|
|Attach Payload||This option is not recommended for normal use because uploading of payloads is retried as required. This option may not be necessary once these issues have been resolved.|
Timeouts are specified for common server operations (such as database queries and ASP page loading, data upload queries, and background service queries) to prevent the server from being blocked while waiting for a response to a query. We recommend that you use the default values unless a specific problem occurs with excessive timeouts.
Note that the Farm Monitor and Alert Console (located on the Monitor Tab) use the ASP.NET Page and Query timeout when performing queries for alert data. If you experience frequent timeouts when using these pages, increase the ASP.NET Page and Query timeout as required.
Data uploading refers to the collection of queued database payloads from machines running an EdgeSight Agent. In most cases, the default values are sufficient for proper operation. Values may need to be adjusted if you receive repeated messages warning of too many queued payloads or other data upload issues. Note that the minimum CPU, memory, and active time timeouts are intended to ensure that only data from machines with more than a minimal amount of activity is uploaded to the server. This provides an accurate view of availability and performance data across the company.
Because application crash logs can be large files, the capability is provided to limit the retention of crash logs by number, by disk consumption, and by date. These limits help prevent crash logs from consuming too much space on the server. You can also disable application crash processing. in which case, no crash log files are uploaded to the server.
If either the maximum number of crash logs or the maximum disk consumption limit is exceeded, application crash processing is automatically disabled until the limit is increased. There is no reset operation that can be used to remove existing payloads.
The SSL Support feature enables secure logins. A valid SSL certificate issued by a trusted certificate authority must be present on the server running the EdgeSight Website. If SSL support is enabled, all agent to server communications must be over SSL. If an agent attempts to connect to an SSL-enabled server without using SSL, an error is generated. Any attempts to establish a connection to the agent (such as running a worker remotely or displaying a real time report) will display an error stating that SSL is required, but this connection did not occur over SSL.
The SNMP Trap Port to be used for outgoing SNMP trap alert actions. This port setting is used for all SNMP trap alert actions defined for all companies hosted on the server. EdgeSight allows you to set the port so that you can avoid conflicts with other management tools which may be using the default SNMP outgoing port. For more information on creating SNMP trap alert actions, see "Creating Alert Rules and Actions".
A company is the primary organizational unit on an EdgeSight Server. A single server can support multiple companies. You create an initial company when installing EdgeSight Server. After installation and post-installation configuration is complete, navigate toto create additional companies as required.
The only information required for creating a company is a name and a time zone. Company names must be unique on the server. If you have multiple EdgeSight Servers and intend to create reports across servers, ensure that the company name is unique on all the servers.
The time zone is used by the server when displaying time stamps and triggering jobs. There is a single time zone for each company defined on an EdgeSight Server. All data for that company is aggregated based on the day boundary for that time zone. This ensures data consistency when agent machines are in a number of different time zones.
This section describes how to manage EdgeSight licenses. For information on configuring EdgeSight to monitor Citrix License Servers, see License Server Monitoring.
Citrix Licensing supplies 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 EdgeSight Web server and by EdgeSight for XenApp agents. A single license server can be shared by multiple Citrix products, including multiple EdgeSight Servers. It is highly recommended that the license server and EdgeSight for Endpoints license files be in place before completing the initial configuration of EdgeSight.
The EdgeSight for Endpoint agent license file (for example, CESEP_*.lic) is located in the MyFiles folder of the license server directory, for example: %ProgramFiles%\Citrix\Licensing\MyFiles.
For more information on EdgeSight for XenApp licensing, see http://support.citrix.com/article/CTX126059.
If EdgeSight for Endpoints support is enabled, you are required to enter a license server name and port during EdgeSight Server installation. During initial configuration using the Post-Installation Wizard, you can test the connection to the license server and, if successful, display the type and number of licenses installed.
EdgeSight Server obtains licenses on behalf of EdgeSight for Endpoints agents from the specified server. You can change the license server name and port after installation by navigating to License Server Name and License Server Port fields as described in “Agent Support and License Server”. The current license server name and port are displayed on the Licensing page, as described in “Using the Licensing Page to Monitor License Status” later in this topic.and editing the
After EdgeSight for XenApp Agents are installed, they receive default agent properties from the associated EdgeSight Server. These properties instruct the agent which license server should be contacted to obtain a license. The following license server options are available:
For more information on agent properties, see Setting Agent Properties and “Agent Properties Wizard”. As with any agent properties, these settings apply to entire departments and are inherited by sub-departments unless overridden at a lower department level.
For EdgeSight for Endpoint Agents, licensing works as follows:
The EdgeSight Server requires one license for each endpoint device reporting up to it. At server startup, the EdgeSight Server attempts to check out one license for each existing device. If not enough licenses are available for the existing devices, all available licenses are checked out and allocated to agents based on when the agent first uploaded data to the server; older agents are given licensing preference over newer agents. Only licensed agents are allowed to upload data to the server. (Devices running agents are tagged as licensed or not licensed in the EdgeSight database.) The server retries license checkouts every minute when it is unable to acquire licenses for all agents. A warning message is added to the messages table and an email is sent to the server administrator. To remedy a shortage of licenses, you must install new licenses, or delete existing devices until compliance is reached.
Once the server is able to properly start up, when a new device reports up to the server, the server checks out a license for that device. After the server has secured a license for a given device, that device can always upload, and further license checks are not performed (except for the startup case mentioned above). If a new endpoint agent is unable to upload due to a license shortage, data collection continues and data is retained in the agent database until groomed. As with the startup case, you must install new licenses, or delete existing devices until compliance is reached before the new devices can upload data.
When a device is deleted from a server, the license for that device is checked in to the license server and available for use by another device.
“Server startup” actually refers to the Server Script Handler (RSSH) startup. When RSSH is stopped, all licenses checked out for that server are checked-in, and available for use by other servers using the same license server, until RSSH restarts.This is important to remember when planning for the number of licenses required. If you have an insufficient number of licenses to cover all devices across all servers, another EdgeSight Server could check out licenses causing a license shortage at startup.
For EdgeSight for XenApp Agents, licensing works as follows:
Use the Licensing page () to display current license usage and status information. The Licensing page displays the following information:
|EdgeSight for XenApp License Statistics|
|Current Licensing Status||
Indicates whether the system is in compliance with the license. In compliance indicates that the number of allowed license violation days have not been exceeded. The license status can be one of the following:
In Compliance—All of the existing devices reporting to this server were able to acquire licenses.
Warning—The number of licenses used has exceeded the number of licenses allowed during this monitoring period. See the Violation Days field for the number of violation days and the servers reporting the violations.
In Violation—The number of licenses used has exceeded the number of licenses allowed for at least 5 days during this monitoring period.
|New Device Grace Period||During this period, agents reporting up with licence violations will not have payloads rejected. A warning email is sent to the EdgeSight Administrator, and a message is posted to the Messages page, indicating that a license violation has occurred. This feature allows administrators to fix problems with initial configurations.|
|Allowed Violation Days||The number of days during the monitoring period for which the number of licenses used are allowed to exceed the number of licenses granted. Uploads are blocked if the number of violation days in the monitored period exceeds five (5) days.|
|Violation Monitoring Period||The number of days for which license violations are tracked.|
|Violation Days||The current number of days during the monitoring period for which the number of licenses exceeded the number of licenses granted. Expand this item to display the dates of license violation and the names of the servers reporting the violation.|
|Endpoint License Statistics|
|Current Licensing Status||
Indicates whether the system is in compliance with the license. The license status can be one of the following:
In Compliance—The EdgeSight Server was able to acquire licenses for all of the existing devices reporting to this server.
Error—The EdgeSight Server was unable to acquire licenses for all of the existing devices on this server. EdgeSight will continually attempt to acquire licenses for all devices.
Stopped—The License Manager is not currently running.
You may also see a message informing you that the server is in the process of acquiring licenses. If, on startup, the server is unable to acquire licenses for all registered endpoint devices, a message is displayed and the server retires license acquisition every 15 minutes. You can retry immediately by clicking the Refresh Endpoint Licensing button. This button is only displayed if there is a license acquisition failure on startup.
|Licensed Devices on This Server||The number of endpoint licenses currently in use by agents reporting to this server. This is displayed in terms of the total number of agents registered with the server. For example, if there are 500 agents registered with the server, and 487 agents are currently using licenses, this filed would display 487 of 500.|
|License Server||The license server name and port number from which EdgeSight obtains endpoint agent licenses. The server and port are specified during installation and can be changed after installation on the Settings page.|
|Total Installed Licenses||The total number of endpoint agent licenses specified by the installed license file.|
|Available Licenses||The number of licenses available for use by endpoint agents.|
|Expiration Date||The date at which the license file will expire. You will be notified prior to license file expiration.|
Authentication providers ensure that only authorized users can log on to an EdgeSight Server. The first step in creating a new user is to select an authentication provider against which a username and password are verified.
A default authentication provider (Email) is included when you install EdgeSight Server. You cannot edit or delete the default authentication provider. The default authentication provider uses an email address as the username. When you create a new user, you specify the email address for the user. Then, an email is sent to the user explaining the sign in process and providing a temporary password. When the user first logs on, they are requested to change their password.
You can create new authentication providers that use Active Directory (AD) for security and sign-on capabilities. Before creating a new provider, make sure you have the LDAP path for your AD authentication provider available.
To set up Active Directory integration with EdgeSight, you must set up an Active Directory authentication provider: Before you begin, make sure you have the LDAP path for your authentication provider available.
Once you have added an authentication provider and set up roles, you must also set up users and/or groups. You may want to create multiple groups within your Active Directory, such as an EdgeSight Admin Group, and an EdgeSight Console User Group for ease of Administration.
|SQL 2012||How to Install EdgeSight 5.4 Web Server with SQL 2012 Standard|
|SQL 2008 R2||How to Configure EdgeSight 5.4 with SQL 2008 R2|
|SQL 2000 and 2005||How to Install and Configure Reporting Services for Use by EdgeSight|
After the Reporting Services installation and configuration is complete, you must configure the connection from EdgeSight Server to the Report Server. Navigate toto specify the report server, credentials for accessing the report server and the data source, and default report and schedule operations. For more information, see the “Report Server Settings” topic in online help.
Reporting Services schedules, in conjunction with the subscription feature, allow you to automate the generation of reports for distribution to users. When an administrator or a user creates a report subscription, they must select an associated schedule. Navigate toto manage existing schedules and create new schedules. For more information, see the “Reporting Services Schedules” topic in online help.
In some cases, such as a week with a holiday or a scheduled company shutdown, you may want to pause report schedules so that the associated reports are not generated.
Care should be taken when deleting schedules. If the deleted schedule is associated with a report, the report will not be generated. Also, subscriptions using the deleted schedule will not result in a report distribution.
You can manage the size of the EdgeSight database by configuring what data is uploaded from agents to the server and how long data is retained before being groomed. These tasks can help ensure acceptable database performance.
You can select what types of performance and availability data you want to upload to the server (). This allows you to optimize EdgeSight Server performance by limiting data uploads to reflect the data used in your enterprise.
The uploading of XenApp Environmental Usage data is disabled by default, and should only be enabled if you plan to use the Environmental Usage report, which displays this data. Depending on the number of sessions for the group or device, the data used to generate these reports can significantly increase the size of your EdgeSight database. In many cases, you may want to enable data collection for a period of time as required and then disable data collection when no longer needed.
EdgeSight collects a wide range of performance, availability, and usage data about end-user systems, applications, user sessions, and the network. The EdgeSight Agents collect data from systems and upload it to a EdgeSight Server. Depending on the number of endpoint and XenApp systems, the number of applications, and network activity, databases can grow quickly without proper management. The primary database management mechanism is grooming.
Grooming is the process of removing older data from a database at regular intervals to make room for new data. Grooming is critical for maintaining efficient database operation. An effective grooming schedule controls database size and helps ensure acceptable performance while retaining sufficient data for business operations.
The following example shows how database grooming settings affect the size of the EdgeSight Server database. You have deployed EdgeSight agents on 2500 end user devices. The devices are running an average of 50 processes and visit an average of 100 Websites over the period of time that network data is retained. The agents are collecting data for 12 hours each workday. Changing the grooming parameter for Network Statistics from 7 to 14 days increases the size of the database by about 40 percent, roughly equivalent in its effect on database size to adding 1000 devices.
EdgeSight has a distributed structure, with EdgeSight Agent databases on each managed device which are uploaded to a single EdgeSight Server database. The data retention settings for the agent database are specified as part of the agent properties and are applied to devices based on their department membership. If persistent data upload timeouts occur for agents using the same configuration, you may want to consider decreasing the values for the Days To Keep In DB and Max Days To Keep In DB agent configuration settings. In some cases, this may result in a loss of data, especialy if managed devices are unable to connect to the EdgeSight Server.
The grooming schedule for the server database is specified as part of the server configuration. The server grooming schedule allows you to specify the number of days that data is retained by data type. This allows data used to identify trends, such as performance data, to be retained longer than data which quickly becomes stale, such as real-time alert data.
The default values for grooming the server database are sufficient for most installations. You may want to use the default values at first and adjust them over time based on user requirements and system performance. In cases where you want to retain more data, consider creating an archive report or performing data warehousing as methods of keeping historical data in preference to relaxing the grooming configuration. See the Citrix EdgeSight User’s Guide for more information on using EdgeSight data for analysis and record keeping.
Server Database Grooming
Navigate toto edit the database grooming schedule, as described in the “Grooming Configuration” online help topic. The Grooming table contains the following information:
In most cases, the grooming schedule is configured to retain one month of data. Application usage data is retained for 90 days due to the need in many environments to track application usage for license and compliance reporting. On the other hand, network data is only retained for 10 days due to high data volumes and the transient nature of the data.
The grooming strategy for a specific data type should take into account how fast the usefulness of the data decreases from time of collection and also how much data is collected on average over a time period. For example, the data in the alert_incoming table has a short shelf life. Real-time alerts are intended to address critical problems that can be resolved by taking action within a short timeframe, such as crashes of mission-critical applications or disruptive network failures. Because of these characteristics and because historical alert data is retained, real-time alert data is groomed aggressively.
It is important to ensure that the grooming schedule is taken into account if data is being warehoused or reports are being archived. If data is transferred less frequently than the grooming schedule for a type of data, data loss can occur. Similarly, report archiving schedules must take into account the grooming schedule to avoid introducing gaps in historical reports.
You can monitor the status of grooming jobs by displaying the grooming log (). The log displays the following information:
In addition to grooming, there are a number of other maintenance jobs which are performed by an EdgeSight Server. These include dealing with data uploads and clearing caches and temporary storage areas. Each job is associated with a schedule, either Fifteen Minute or Nightly. The Fifteen Minute schedule runs jobs at fifteen minute intervals whenever EdgeSight Server is operational and is not configurable. The Nightly schedule runs jobs once a night and can have a start time configured. By default, the start time is five minutes after midnight based on server time. This allows the job to run to completion when the fewest users are active. The following table shows which console pages to display when managing maintenance jobs.
|Display job schedules, edit the start time for the Nightly schedule, and manually run jobs associated with schedules.|
|Determine when jobs last ran and their completion status. You can also display the overall duration of the set of jobs and the last run duration of individual jobs.|
|Display the run history of individual jobs, including result, duration, and start time.|
Unmanaged devices are systems running an EdgeSight agent that are not associated with a company and department. The agent can communicate with the server and be included in the list of unmanaged devices as long as it has a valid server and port specified during installation. Devices may be unmanaged due to the following reasons:
You can monitor the number of unmanaged devices from the System Status page or by navigating to Registered Org field.. The Unmanaged Devices page allows you to move a device to a company and department. Devices running EdgeSight for XenApp 5.0 agents can only be moved to the PS Farms department. All other devices can be moved to the Endpoints department. For agents that were previously registered with the server, the department to which the device last uploaded data is displayed in the
The EdgeSight Agent on an unmanaged device collects data and uploads data to the server but will not appear in any historical or real-time reports. The data is subject to grooming, so allowing devices to remain unmanaged for lengths of time may result in lost data. Review the Last Upload field to determine when the agent on the device last communicated with the server.
The configuration pages under the Agent Database Broker folder (Pools, Agent Database Servers, and Broker History) only display data if the EdgeSight Server is acting as a database broker for EdgeSight for Endpoints Agents installed on virtual desktops in a pooled environment. Although the database broker components are included in all EdgeSight Server installations, they are not used unless the server is specified as the database broker during the Agent Database Server and the EdgeSight Agent installations. For a description of the various components required for monitoring virtual desktops, see Installing EdgeSight for Monitoring Virtual Desktops.
These pages reflect the status reported by Agent Database Servers, pools, and devices (in this case, virtual desktops running EdgeSight agents). In most cases, actions taken on these pages are housekeeping changes, such as deleting an unused pool or deleting stranded registration information for an Agent Database Server. Actions which directly affect your environment are rebalancing pools and enabling/disabling Agent Database Servers.
Use the Pools page () to display information about pools (named groups of virtual desktops). The pool name corresponds to the XenDesktop desktop group name. In addition to displaying pool status, you can rebalance or delete pools.
The rebalance feature allows you to manually force a redistribution of agents in relation to database servers. The agents are not immediately rebalanced; the redistribution takes place over time as virtual desktops are shut down and rebooted.
Deleting pools is a housekeeping function that should be performed when all the agent database servers associated with a pool have been deleted. For more information about pool rebalancing and deletion, see the “Pools” topic in online help.
Use the Agent Database Servers page () to display current server status and to perform actions related to all the agent database servers which have registered with the database broker components of EdgeSight Server. You can disable/enable and delete servers.
If maintenance is required or a problem has occurred on a database server, you can disable the database server. Disabling a server means that the database broker components of EdgeSight Server do not broker the server to new agents. The agents already using the database server continue to store data in the database. Once the maintenance has been performed or the issue resolved, you can enable the server to make it available for brokering to agents.
Deleting an agent database server only deletes the registration data stored on the EdgeSight Server database, such as the agent database server name, port, and pool association. The feature is designed to allow you to remove a stranded registration for a server which has been uninstalled or assigned to another EdgeSight Server.
For more information on server status, disabling/enabling servers, and deleting servers, see the “Agent Database Servers” topic in online help.
Use the Broker History page () to display status messages for EdgeSight Agent Database Servers, pools, and devices. The message list can be filtered by server, pool, or device, providing a chronological history of the selected component. Most messages are informational, but errors are displayed for agents which are unable to connect to a database server. Note that long error strings are truncated to about 512 characters. See the “Broker History” online help topic for more information on individual columns in the Broker History table.
You can enable detailed logging for use in debugging broker issues on the Agent Database Broker tab at , as described in “Agent Database Broker Logging”.
During installation, an agent can be configured to contact the EdgeSight Server acting as a database broker to receive a database connection string. If the fails to get a database connection, the agent shuts down and writes error information to the local SYS_EVENT_TXT.TXT log. If the File Monitor service on the agent is functioning properly, a copy of this file will be copied to the agent data file share. If the problem is that an incorrect path was supplied for the database broker, you can change configuration settings using the Citrix System Monitoring Agent control panel applet. However, you must make those changes on the base image in order for them to be propagated to all desktops. For more information on installing and configuring agents in a pooled environment, see Installing EdgeSight for Monitoring Virtual Desktops.
The Messages page () displays status and event messages for EdgeSight Server and for devices running EdgeSight Agents. You can filter the list of messages by message type (All Types, Error, Warning, Informational, New Device, or Active Monitoring) and by company (All Companies, No Company Specified, or a specific company).
The Server Script Host page () displays the status of services on EdgeSight Server. These services include basic server functions, such as alert, payload and crash file handling, and maintenance functions, such as the cleanup of temp folders and crash report folders. Each service has an associated log file which may be helpful in isolating problems with server operations. You can also start and stop services, although this should generally be done at the direction of Citrix Technical Support.