Product Documentation

Alerts and notifications

Jul 08, 2016

Monitor alerts

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

localized image

A warning alert (yellow triangle) indicates that the minimum threshold of a condition has been reached.

A critical alert (red circle) shows that the maximum threshold of a condition has been 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 Server OS machines for a specific Delivery Group over the last month.

localized image

Citrix alerts. Citrix alerts are alerts monitored in Director which 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 meet and exceed the thresholds you have set up. For more information on setting up Citrix Alerts, see Create alerts policies.

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 SCOM alerts and Configure SCOM integration.

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

localized image

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

  1. Go to Alerts > Citrix Alerts Policy and select, for example, Server OS Policy.
  2. Click Create.
  3. Name and describe the policy, then set the conditions which 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 higher 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, then 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 will 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 in 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 may take approximately 30 seconds to complete the configuration. A spinner is displayed during this time.

Alerts policies conditions

Alert policy condition

Description and recommended actions

Peak Connected Sessions

Number of peak connected sessions.

Recommended actions when alert displays:

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

Peak Disconnected Sessions

Number of peak disconnected sessions.

Recommended actions when alert displays:

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

Peak Concurrent Total Sessions

Number of peak concurrent sessions.

Recommended actions when alert displays:

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

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.

Recommended actions when alert displays:

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

Failed Machines (Desktop OS)

Number of failed Desktop OS machines.

Recommended actions when alert displays:

  • Failures can occur for various reasons as shown in the Director Dashboard and Filters views. Run Citrix Scout diagnostics to determine root cause. For more information, see Troubleshoot user issues.

Failed Machines (Server OS)

Number of failed Server OS machines.

Recommended actions when alert displays:

  • Failures can occur for various reasons as shown in the Director Dashboard and Filters views. Run Citrix Scout diagnostics to determine root cause.

Average Logon Duration

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

Recommended actions when alert displays:

  • 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 cause elongated logons.
  • Check the baseline and break down of the logons to narrow down the cause.

Load Evaluator Index

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

Recommended actions when alert displays:

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

SCOM alerts

SCOM integration with Director lets you view alert information from Microsoft System Center 2012 Operations Manager (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.

Configure SCOM integration

SCOM integration uses remote PowerShell 3.0 or higher 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.

localized image

The requirements for SCOM integration are:

  • Windows Server 2012 R2
  • System Center 2012 R2 Operations Manager
  • PowerShell 3.0 or higher (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 they can retrieve full alert information in Director. If this is not possible, a SCOM administrator account can be configured in the web.config file using the DirectorConfig tool, however it is not recommended.
  • Citrix recommends that you do not configure more than 10 Director administrators per SCOM Management Server. This is to ensure that the SCOM Management Server is moderately loaded for optimal performance.

On the Director server:

1. On the Director server, type Enable-PSRemoting to enable PowerShell remoting.

2. Add the SCOM Management Server to the TrustedHosts list. Open an elevated PowerShell prompt in From an elevated PowerShell command line, and execute the following command(s):

a. Get the current list of TrustedHosts

command Copy

Get-Item WSMAN:\localhost\Client\TrustedHosts

b. 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.

command Copy

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

3. Configure SCOM using the DirectorConfig tool.

command Copy

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

On the SCOM Management server:

1. Assign Director administrators to a SCOM administrator role.

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

b. In User Roles, you can create a new User Role or modify an existing one. There are four categories of SCOM operators. These roles define the nature of access to SCOM data. For example, a read-only SCOM operator will not see the Administration pane and cannot discover or manage rules, machines or accounts. A SCOM Operator role is a full administrator role.

Note:

If a Director administrator is assigned to non-operator role the following operations will not be available to the Director administrator.

i. If there are multiple management servers configured and, in the event of primary management server not being available, the Director administrator will not be able to connect to secondary management server.
The primary management server is the server configured in the Director web.config file, which is the same server as the one specified in step 3. above with the DirectorConfig tool. The secondary management servers are peer management servers of the primary server.

ii. While filtering alerts, the Director administrator will not be able to search for the alert Source. This requires an operator level permission.

c. To modify any User Role, right click on the role, then click Properties.

d. 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:

a. Modify MaxConcurrentUsers:

In CLI:

command Copy

winrm set winrm/config/winrs @{MaxConcurrentUsers = "20"}

In PS:

command Copy

Set­-Item WSMan:\localhost\Shell\MaxConcurrentUsers 20

b. Modify MaxShellsPerUser:

In CLI:

command Copy

winrm set winrm/config/winrs @{MaxShellsPerUser="20"}

In PS:

command Copy

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

c. Modify MaxMemoryPerShellMB:

In CLI:

command Copy

winrm set winrm/config/winrs @{MaxMemoryPerShellMB="1024"}

In PS:

command Copy

Set­-Item WSMan:\localhost\Shell\MaxMemoryPerShellMB 1024

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

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

Key: LocalAccountTokenFilterPolicy

Type: DWord

Value: 1

Warning

Editing the registry incorrectly can cause serious problems that may 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 may see the message "Cannot get the latest SCOM alerts. View the Director server event logs for more information". The server event logs will 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.