Alerts and notifications

Alerts are displayed in Director on the dashboard and other high level views with warning and critical alert symbols. Alerts are available for Premium licensed sites. Alerts update automatically every minute; you can also update alerts on demand.

Director Alerts

A warning alert (amber triangle) indicates that the warning threshold of a condition has been reached or exceeded.

A critical alert (red circle) shows that the critical threshold of a condition has been reached or exceeded.

You can view more detailed information on alerts by selecting an alert from the sidebar, clicking the Go to Alerts link at the bottom of the sidebar or by selecting Alerts from the top of the Director page.

In the Alerts view, you can filter and export alerts. For example, Failed Multi-session OS machines for a specific Delivery Group over the last month, or all alerts for a specific user. For more information, see Export reports.

Filter alerts

Citrix alerts

Citrix alerts are alerts monitored in Director that originate from Citrix components. You can configure Citrix alerts within Director in Alerts > Citrix Alerts Policy. As part of the configuration, you can set notifications to be sent by email to individuals and groups when alerts exceed the thresholds you have set up. For more information on setting up Citrix Alerts, see Create alerts policies.

Note:

Ensure that your firewall, proxy, or Microsoft Exchange Server do not block the email alerts.

Smart alert policies

A set of built-in alert policies with predefined threshold values is available for Delivery Groups and Multi-session OS VDA scope. This feature requires Delivery Controller(s) version 7.18 or later. You can modify the threshold parameters of the built-in alert policies in Alerts > Citrix Alerts Policy. These policies are created when there is at least one alert target -a Delivery Group or a Multi-session OS VDA defined in your site. Additionally, these built-in alerts are automatically added to a new delivery group or a Multi-session OS VDA.

In case you upgrade Director and your site, the alert policies from your previous Director instance are carried over. Built-in alert policies are created only if no corresponding alert rules exist in the Monitor database.

For the threshold values of the built-in alert policies, see the Alerts policies conditions section.

Built in alerts

SCOM alerts

SCOM alerts display alert information from Microsoft System Center 2012 Operations Manager (SCOM) to provide a more comprehensive indication of data center health and performance within Director. For more information, see the Configure SCOM alerts integration section.

The number of alerts displayed next to the alerts icons before you expand the sidebar are the combined sum of Citrix and SCOM alerts.

Create alerts policies

Director Alerts Policies

To create a new alerts policy, for example, to generate an alert when a specific set of session count criteria is met:

  1. Go to Alerts > Citrix Alerts Policy and select, for example, Multi-session OS Policy.
  2. Click Create.
  3. Name and describe the policy, then set the conditions that have to be met for the alert to be triggered. For example, specify Warning and Critical counts for Peak Connected Sessions, Peak Disconnected Sessions, and Peak Concurrent Total Sessions. Warning values must not be greater than Critical values. For more information, see Alerts policies conditions.
  4. Set the Re-alert interval. If the conditions for the alert are still met, the alert is triggered again at this time interval and, if set up in the alert policy, an email notification is generated. A dismissed alert does not generate an email notification at the re-alert interval.
  5. Set the Scope. For example, set for a specific Delivery Group.
  6. In Notification preferences, specify who should be notified by email when the alert is triggered. You have to specify an email server on the Email Server Configuration tab in order to set email Notification preferences in Alerts Policies.
  7. Click Save.

Creating a policy with 20 or more Delivery Groups defined in the Scope might take approximately 30 seconds to complete the configuration. A spinner is displayed during this time.

Creating more than 50 policies for up to 20 unique Delivery Groups (1000 Delivery Group targets in total) might result in an increase in response time (over 5 seconds).

Moving a machine containing active sessions from one Delivery Group to another might trigger erroneous Delivery Group alerts that are defined using machine parameters.

Alerts policies conditions

Find below the alert categories, recommended actions to mitigate the alert, and built-in policy conditions if defined. The built-in alert policies are defined for alert and realert intervals of 60 minutes.

Peak Connected Sessions

  • Check Director Session Trends view for peak connected sessions.
  • Check to ensure that there is enough capacity to accommodate the session load.
  • Add new machines if needed

Peak Disconnected Sessions

  • Check Director Session Trends view for peak disconnected sessions.
  • Check to ensure that there is enough capacity to accommodate session load.
  • Add new machines if needed.
  • Log off disconnected sessions if needed

Peak Concurrent Total Sessions

  • Check Director Session Trends view in Director for peak concurrent sessions.
  • Check to ensure that there is enough capacity to accommodate session load.
  • Add new machines if needed.
  • Log off disconnected sessions if needed

CPU

Percentage of CPU usage indicates the overall CPU consumption on the VDA, including that of the processes. You can get more insight into the CPU utilization by individual processes from the Machine details page of the corresponding VDA.

  • Go to Machine Details > View Historical Utilization > Top 10 Processes, identify the processes consuming CPU. Ensure that process monitoring policy is enabled to initiate collection of process level resource usage statistics.
  • End the process if necessary.
  • Ending the process causes unsaved data to be lost.
  • If all is working as expected, add additional CPU resources in the future.

    Note:

    The policy setting, Enable resource monitoring is allowed by default for the monitoring of CPU and memory performance counters on machines with VDAs. If this policy setting is disabled, alerts with CPU and memory conditions are not triggered. For more information, see Monitoring policy settings

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 80%, Critical - 90%

Memory

Percentage of Memory usage indicates the overall memory consumption on the VDA, including that of the processes. You can get more insight into the memory usage by individual processes from the Machine details page of the corresponding VDA.

  • Go to Machine Details > View Historical Utilization > Top 10 Processes, identify the processes consuming memory. Ensure that process monitoring policy is enabled to initiate collection of process level resource usage statistics.
  • End the process if necessary.
  • Ending the process causes unsaved data to be lost.
  • If all is working as expected, add additional memory in the future.

    Note:

    The policy setting, Enable resource monitoring, is allowed by default for the monitoring of CPU and memory performance counters on machines with VDAs. If this policy setting is disabled, alerts with CPU and memory conditions are not triggered. For more information, see Monitoring policy settings

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 80%, Critical - 90%

Connection Failure Rate

Percentage of connection failures over the last hour.

  • Calculated based on the total failures to total connections attempted.
  • Check Director Connection Failures Trends view for events logged from the Configuration log.
  • Determine if applications or desktops are reachable.

Connection Failure Count

Number of connection failures over the last hour.

  • Check Director Connection Failures Trends view for events logged from the Configuration log.
  • Determine if applications or desktops are reachable.

ICA RTT (Average)

Average ICA round-trip time.

  • Check Citrix ADM for a breakdown of the ICA RTT to determine the root cause. For more information, see Citrix ADM documentation.
  • If Citrix ADM is not available, check the Director User Details view for the ICA RTT and Latency, and determine if it is a network problem or an issue with applications or desktops.

ICA RTT (No. of Sessions)

Number of sessions that exceed the threshold ICA round-trip time.

  • Check Citrix ADM for the number of sessions with high ICA RTT. For more information, see Citrix ADM documentation.
  • If Citrix ADM is not available, work with the network team to determine the root cause.

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 300 ms for 5 or more sessions, Critical - 400ms for 10 or more sessions

ICA RTT (% of Sessions)

Percentage of sessions that exceed the average ICA round-trip time.

  • Check Citrix ADM for the number of sessions with high ICA RTT. For more information, see Citrix ADM documentation.
  • If Citrix ADM is not available, work with the network team to determine the root cause.

ICA RTT (User)

ICA round-trip time that is applied to sessions launched by the specified user. The alert is triggered if ICA RTT is greater than the threshold in at least one session.

Failed Machines (Single-session OS)

Number of failed Single-session OS machines. Failures can occur for various reasons as shown in the Director Dashboard and Filters views.

  • Run Citrix Scout diagnostics to determine the root cause. For more information, see Troubleshoot user issues.

    Smart policy conditions:

    • Scope: Delivery Group scope
    • Threshold values: Warning - 1, Critical - 2

Failed Machines (Multi-session OS)

Number of failed Multi-session OS machines. Failures can occur for various reasons as shown in the Director Dashboard and Filters views.

  • Run Citrix Scout diagnostics to determine the root cause.

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 1, Critical - 2

Average Logon Duration

Average logon duration for logons that occurred over the last hour.

  • Check the Director Dashboard to get up-to-date metrics regarding the logon duration. A large number of users logging in during a short timeframe can increase the logon duration.
  • Check the baseline and break down of the logons to narrow down the cause. For more information, see Diagnose user logon issues

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 45 seconds, Critical - 60 seconds

Logon Duration (User)

Logon duration for logons for the specified user that occurred over the last hour.

Load Evaluator Index

Value of the Load Evaluator Index over the last 5 minutes.

  • Check Director for Multi-session OS Machines that might have a peak load (Max load). View both Dashboard (failures) and Trends Load Evaluator Index report.

    Smart policy conditions:

    • Scope: Delivery Group, Multi-session OS scope
    • Threshold values: Warning - 80%, Critical - 90%

Hypervisor Alerts Monitoring

Director displays alerts to monitor hypervisor health. Alerts from Citrix Hypervisor and VMware vSphere help monitor hypervisor parameters and states. The connection status to the hypervisor is also monitored to provide an alert if the cluster or pool of hosts is rebooted or unavailable.

To receive hypervisor alerts, ensure that a hosting connection is created in Citrix Studio. For more information, see Connections and resources. Only these connections are monitored for hypervisor alerts. The following table describes the various parameters and states of Hypervisor alerts.

Alert Supported Hypervisors Triggered by Condition Configuration
CPU usage Citrix Hypervisor, VMware vSphere Hypervisor CPU usage alert threshold is reached or exceeded Alert thresholds must be configured in the Hypervisor.
Memory usage Citrix Hypervisor, VMware vSphere Hypervisor Memory usage alert threshold is reached or exceeded Alert thresholds must be configured in the Hypervisor.
Network usage Citrix Hypervisor, VMware vSphere Hypervisor Network usage alert threshold is reached or exceeded Alert thresholds must be configured in the Hypervisor.
Disk usage VMware vSphere Hypervisor Disk usage alert threshold is reached or exceeded Alert thresholds must be configured in the Hypervisor.
Host connection or power state VMware vSphere Hypervisor Hypervisor Host has been rebooted or is unavailable Alerts are prebuilt in VMware vSphere. No additional configurations are needed.
Hypervisor connection unavailable Citrix Hypervisor, VMware vSphere Delivery Controller Connection to the hypervisor (pool or cluster) is lost or powered down or rebooted. This alert is generated every hour as long as the connection is unavailable. Alerts are prebuilt with the Delivery Controller. No additional configurations are needed.

Note:

For more information about configuring alerts, see Citrix XenCenter Alerts or check the VMware vCenter Alerts documentation.

Email notification preference can be configured under Citrix Alerts Policy > site Policy > Hypervisor Health. The threshold conditions for Hypervisor alert policies can be configured, edited, disabled, or deleted from the hypervisor only and not from Director. However, modifying email preferences and dismissing an alert can be done in Director.

Important:

  • Alerts triggered by the Hypervisor are fetched and displayed in Director. However, changes in the life cycle/state of the Hypervisor alerts are not reflected in Director.
  • Alerts that are healthy or dismissed or disabled in the Hypervisor console continues to appear in Director and have to be dismissed explicitly.
  • Alerts that are dismissed in Director are not dismissed automatically in the Hypervisor console.

Hypervisor Alerts filter

A new Alert category called Hypervisor Health has been added to enable filtering only the hypervisor alerts. These alerts are displayed once the thresholds are reached or exceeded. Hypervisor alerts can be:

  • Critical—critical threshold of the hypervisor alarm policy reached or exceeded
  • Warning—warning threshold of the hypervisor alarm policy reached or exceeded
  • Dismissed—alert no longer displayed as an active alert

Hypervisor Alerts Display

This feature requires Delivery Controller version 7 1811 or later. If you are using an older version of Director with sites 7 1811 or later, only the hypervisor alert count is displayed. To view the alerts, you must upgrade Director.

Configure SCOM alerts integration

SCOM integration with Director lets you view alert information from SCOM on the Dashboard and in other high-level views in Director.

SCOM alerts are displayed on-screen alongside Citrix alerts. You can access and drill down into SCOM alerts from SCOM tab in the side bar.

You can view historical alerts up to one month old, sort, filter, and export the filtered information to CSV, Excel, and PDF report formats. For more information, see Export reports.

SCOM integration uses remote PowerShell 3.0 or later to query data from the SCOM Management Server and it maintains a persistent runspace connection in the user’s Director session. Director and SCOM server must have the same PowerShell version.

SCOM component diagram

The requirements for SCOM integration are:

  • Windows Server 2012 R2
  • System Center 2012 R2 Operations Manager
  • PowerShell 3.0 or later (PowerShell version on Director and the SCOM server must match)
  • Quad Core CPU with 16 GB RAM (recommended)
  • A primary Management Server for SCOM must be configured in the Director web.config file. You can do this using the DirectorConfig tool.

Citrix recommends that the Director administrator account is configured as a SCOM Operator role so that full alert information can be retrieved in Director. If this is not possible, a SCOM administrator account can be configured in the web.config file using the DirectorConfig tool.

Citrix further recommends that you do not configure more than 10 Director administrators per SCOM Management Server to ensure optimal performance.

On the Director server:

  1. Type Enable-PSRemoting to enable PowerShell remoting.

  2. Add the SCOM Management Server to the TrustedHosts list. Open a PowerShell prompt and execute the following command(s):

    • Get the current list of TrustedHosts

      Get-Item WSMAN:\localhost\Client\TrustedHosts

    • Add the FQDN of the SCOM Management Server to the list of TrustedHosts. <Old Values> represents the existing set of entries returned from Get-Item cmdlet.

      Set-Item WSMAN:\localhost\Client\TrustedHosts -Value “<FQDN SCOM Management Server>,<Old Values>”

  3. Configure SCOM using the DirectorConfig tool.

    C:\inetpub\wwwroot\Director\tools\DirectorConfig.exe /configscom

On the SCOM Management server:

  1. Assign Director administrators to a SCOM administrator role.

    1. Open the SCOM Management console and go to Administration > Security > User Roles.

    2. In User Roles, you can create a new User Role or modify an existing one. There are four categories of SCOM operator roles that define the nature of access to SCOM data. For example, a Read-Only role does not see the Administration pane and cannot discover or manage rules, machines or accounts. An Operator role is a full administrator role.

      Note:

      The following operations are not available if the Director administrator is assigned to a non-operator role:

      • If there are multiple management servers configured and the primary management server is not available, the Director administrator cannot connect to the secondary management server. The primary management server is the server configured in the Director web.config file, that is the same server as the one specified with the DirectorConfig tool in step 3 above. The secondary management servers are peer management servers of the primary server.
      • While filtering alerts, the Director administrator cannot search for the alert source. This requires an operator level permission.
    3. To modify any User Role, right-click on the role, then click Properties.

    4. In the User Role Properties dialog, you can add or remove Director administrators from the specified user role.

  2. Add Director administrators to the Remote Management Users group on the SCOM Management server. This allows the Director administrators to establish a remote PowerShell connection.

  3. Type Enable-PSRemoting to enable PowerShell remoting.

  4. Set the WS-Management properties limits:

    1. Modify MaxConcurrentUsers:

      In CLI:

      ```winrm set winrm/config/winrs @{MaxConcurrentUsers = “20”}

      
      In PS:
      
      ```Set­-Item WSMan:\localhost\Shell\MaxConcurrentUsers 20<!--NeedCopy-->
      
    2. Modify MaxShellsPerUser:

      In CLI:

      winrm set winrm/config/winrs @{MaxShellsPerUser="20"}<!--NeedCopy-->

      In PS:

    ```Set-Item WSMan:\localhost\Shell\MaxShellsPerUser 20

    
    1.  Modify MaxMemoryPerShellMB:
    
        In CLI:
    
        ```winrm set winrm/config/winrs @{MaxMemoryPerShellMB="1024"}<!--NeedCopy-->
    
    In PS:
    

    Set­-Item WSMan:\localhost\Shell\MaxMemoryPerShellMB 1024<!--NeedCopy-->

  5. To ensure that SCOM integration works in mixed domain environments, set the following registry entry.

Path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System

Key: LocalAccountTokenFilterPolicy

Type: DWord

Value: 1

Caution: Editing the registry incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Once SCOM integration is set up you might see the message “Cannot get the latest SCOM alerts. View the Director server event logs for more information”. The server event logs help identify and correct the problem. Causes can include:

  • Loss of network connectivity at the Director or SCOM machine.
  • The SCOM service is not available or too busy to respond.
  • Failed authorization due to a change in permissions for the configured user.
  • An error in Director while processing the SCOM data.
  • PowerShell version mismatch between Director and SCOM server.
Alerts and notifications