Install and configure the Content Pack for Monitoring Citrix

Perform the following high-level steps to configure the Content Pack for Monitoring Citrix:

1. Install the Add-on for the Content Pack for Monitoring Citrix
2. Install the Content Pack for Monitoring Citrix
3. Optionally update the index search macro with custom index
4. Import Citrix services and entities
5. Review and tune KPI base searches
6. Review and tune KPI thresholds

Prerequisites

Prerequisite	Description
Install Citrix XenDesktop add-ons	The saved searches in this content pack depend on data from two Citrix XenDesktop technical add-ons: the XenDesktop brokers and the XenDesktop VDAs. See Data requirements for the Content Pack for Monitoring Citrix. For detailed installation instructions, see Template for Citrix XenDesktop 7 Installation on GitHub.
Back up your environment	Create a full backup of your ITSI environment in case you need to uninstall the content pack later. For more information, see Create a full backup in the Administration Manual.
Administrator privileges	To optionally update the index search macro with custom index, you should have the itoa_admin role.

Install the Add-on for the Content Pack for Monitoring Citrix

Download and install the Add-on for the Content Pack for Monitoring Citrix from Splunkbase. The add-on provides the saved searches required to import Citrix services and entities. You must install the add-on prior to installing the content pack, otherwise the installation fails.

Install the content pack

The Content Pack for Monitoring Citrix is automatically available for installation once you have installed the Splunk App for Content Packs on the search head with ITSI 4.9.0 or later. If you are using ITSI version 4.8.x or earlier, then you need to install the content pack using backup and restore functionality provided by ITSI. For more information, see Install the content pack on ITSI version 4.8 and earlier.

Install the content pack on ITSI version 4.9 or later

Perform the following steps to install the Content Pack for Monitoring Citrix from the Data Integrations page on ITSI version 4.9.x or later:

1. From the ITSI main menu, click Configuration > Data Integrations.
2. Select Add content packs or Add structure to your data depending on your version of ITSI.
3. Select the Monitoring Citrix content pack.
4. Review what's included in the content pack and then click Proceed.
5. Configure the following settings:

   Setting	Description
   Choose which objects to install	For a first-time installation, select the items you want to install and deselect any you're not interested in. For an upgrade, the installer identifies which objects from the content pack are new and which ones already exist in your environment from a previous installation. You can selectively choose which objects to install from the new version, or install them all.
   Choose a conflict resolution rule for the objects you install	For upgrades or subsequent installs, decide what happens to duplicate objects introduced from the content pack. Choose from the following options: Install as new - Objects are installed and any existing identical objects in your environment remain intact. Replace existing - Existing identical objects are replaced with those from the new installation. Any changes you previously made to these objects are overwritten.
   Import as enabled	Select whether to install objects as enabled or to leave them in their original state. It's recommended that you import objects as disabled to ensure your environment doesn't break from the addition of new content. This setting only applies to services, correlation searches, and aggregation policies. All other objects such as KPI base searches and saved searches are installed in their original state regardless of which option you choose.
   Add a prefix to your new objects	Optionally, append a custom prefix to each object installed from the content pack. For example, you might prefix your objects with CP- to indicate they came from a content pack. This option can help you locate and manage the objects post-install.
   Backfill service KPIs	Optionally backfill your ITSI environment with the previous seven days of KPI data. Consider enabling backfill if you want to configure adaptive thresholding and Predictive Analytics for the new services. This setting only applies to KPIs and not service health scores.

6. When you're satisfied with your selections, click Install selected.
7. Click Install to confirm the installation. When the installation completes you can view all objects that were successfully installed in your environment. A green check mark in the main Content Library list indicates which content packs you've already installed.

Install the content pack through the REST API

On ITSI version 4.8.x you can use the itoa_interface/content_pack endpoint to install content packs through the ITSI REST API. The endpoint includes GET operations to fetch versioning information and preview the contents of the content pack, and a POST operation to install content packs.

Install the content pack on ITSI version 4.8 or earlier

If you're on ITSI version 4.8.0 or lower, perform the following steps to install the content pack:

1. Download the following ITSI backup file: BACKUP-CP-CITRIX-1.0.0.zip.
2. On your ITSI search head, create a restore job and upload the backup file. For instructions, see Restore from a backup zip file.
3. After the restore job completes, confirm that the objects included in the content pack are restored to your environment.

(Optional) Update the index search macro with custom index

To update the index search macro, you have to know the indexes your organization uses to send data from the Add-on to your Splunk platform deployment.

Steps:

1. From Splunk Web, select Settings > Advanced Search > Search Macros.
2. Configure the custom index by revising macro definitions as shown in the table below.
3. Select Save.

Macro Name	Index Type	Default Macro Definition	Macro Definition with Custom Index
itsi-cp-citrix-netscaler-index	Events	index=netscaler	All of the indexes that you're using for data collection from add-ons combined with OR operators. For example: index=netscaler OR index=<index-name>
itsi-cp-citrix-xd-perfmon-index	Events	index=xd_perfmon	All of the indexes that you're using for data collection from add-ons combined with OR operators.. For example: index=xd_perfmon OR index=<index-name>

Import Citrix services and entities

Import the following Citrix application and infrastructure components as ITSI services and entities:

Import StoreFront entities

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Storefront_Entity_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   IP	Entity Alias
   SiteName	Entity Information Field
   host	Entity Alias
   web_server	Entity Alias
   CitrixRole	Entity Information Field
   Tmp_entity	Entity Title

7. Click Import to import your StoreFront entities.

Import StoreFront services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Storefront_Service_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   SiteName	Do Not Import
   ServiceName	Service Title
   ServiceTemplateLink	Service Template Link

7. Click Next.
8. Click Citrix XenDesktop Storefront Template and complete the entity rule with SiteName matches SiteName.
9. Click Import to import your StoreFronts as services.

Import Gateway entities

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Gateway_Entity_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the entities in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   GWIP	Entity Alias
   netscaler_name	Entity Alias
   SiteName	Entity Information Field
   ext_ip	Entity Alias
   CitrixRole	Entity Information Field
   Tmp_entity	Entity Title

7. Click Import to import your Gateway entities.

Import Gateway services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Gateway_Service_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   netscaler_name	Do Not Import
   SiteName	Do Not Import
   ServiceDependency	Dependent Services
   ServiceName	Service Title
   ServiceTemplateLink	Service Template Link

7. Click Next.
8. Click Citrix XenDesktop Gateway Template and complete the entity rule with SiteName matches SiteName.
9. Click Import to import your Gateway services.

Import delivery controllers

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Sites_By_Controller_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   MachineName	Entity Alias
   DNSName	Entity Alias
   ControllerVersion	Entity Information Field
   OSType	Entity Information Field
   OSVersion	Entity Information Field
   UUID	Entity Alias
   SiteName	Entity Information Field
   CitrixRole	Entity Information Field
   host	Entity Alias
   tmp_entity	Entity Title

7. Click Import to import your delivery controllers.

Import sites

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Sites_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the site names in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   SiteName	Service Title
   ServiceDependency	Dependent Services
   ServiceTemplateLink	Service Template Link

7. Click Next.
8. Click Citrix XenDesktop Site Template and complete the entity rule with SiteName matches SiteName.
9. Click Import to import your sites as services.

Import Delivery Group entities

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Delivery_Group_Service_Entity_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the entities in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   DesktopGroupName	Entity Alias
   DesktopKind	Entity Information Field
   DeliveryType	Entity Information Field
   SiteName	Entity Information Field
   CitrixRole	Entity Information Field
   Tmp_entity	Entity Title

7. Click Import to import your Delivery Group entities.

Import Delivery Group services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Delivery_Group_Service_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the services in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   ServiceDependency	Dependent Services
   ServiceTemplateLink	Service Template Link
   ServiceTitle	Service Title
   SiteName	Do Not Import

7. Click Next.
8. Click Citrix XenDesktop Delivery Group Template and complete the entity rule with SiteName matches SiteName.
9. Click Import to import your Delivery Groups as services.

Import Machine Catalog entities

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Machine_Catalog_Service_Entity_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the entities in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   CatalogName	Entity Alias
   SiteName	Entity Information Field
   AllocationType	Entity Information Field
   DeliveryType	Entity Information Field
   DesktopKind	Entity Information Field
   ZoneName	Entity Information Field
   CitrixRole	Entity Information Field
   tmp_entity	Entity Title

7. Click Import to import your Machine Catalogs as entities.

Import Machine Catalog services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_Machine_Catalog_Service_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the services in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   ServiceDependency	Dependent Services
   ServiceTemplateLink	Service Template Link
   ServiceTitle	Service Title
   SiteName	Do Not Import

7. Click Next.
8. Click Citrix XenDesktop Machine Catalog Template and complete the entity rule with SiteName matches SiteName.
9. Click Import to import your Machine Catalogs as services.

Import VDA entities

1. Within ITSI, go to Configuration > Entities.
2. Click Create Entity > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_VDA_Entity_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the entities in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   MachineName	Entity Alias
   DNSName	Entity Alias
   DesktopGroupName	Entity Information Field
   DesktopKind	Entity Information Field
   IPAddress	Entity Alias
   OSType	Entity Information Field
   OSVersion	Entity Information Field
   SiteName	Entity Information Field
   ZoneName	Entity Information Field
   CatalogName	Entity Information Field
   CitrixRole	Entity Information Field
   tmp_entity	Entity Title

7. Click Import to import your VDAs as entities.

Import VDA Delivery Group services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_VDA_Delivery_Group_Services_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the services in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   DesktopGroupName	Service Title
   SiteName	Do Not Import
   ServiceDependency	Dependent Services
   ServiceTemplateLink	Service Template Link

7. Click Next.
8. Click Citrix XenDesktop VDA Delivery Group Template and complete the following entity rules:
   • SiteName matches SiteName
   • DesktopGroupName matches DesktopGroupName
9. Click Import to import the services.

Import VDA Machine Catalog services

1. Within ITSI, go to Configuration > Services.
2. Click Create Service > Import from Search.
3. Enter the following ad hoc search:

   | savedsearch TA-ITSI-CITRIX-XD7-Citrix_VDA_Machine_Catalog_Services_Importer

4. Change the time range to Last 7 days and click the search icon.
5. Review the services in the search results, then click Next.
6. Specify the following columns:

   Column Name	Import Column As
   CatalogName	Service Title
   SiteName	Do Not Import
   ServiceDependency	Dependent Services
   ServiceTemplateLink	Service Template Link

7. Click Next.
8. Click Citrix XenDesktop VDA Machine Catalog Template and complete the following entity rules:
   • SiteName matches SiteName
   • CatalogName matches CatalogName
9. Click Import to import the services.

Review and tune KPI base searches

Within ITSI, go to Configuration > KPI Base Searches. Review and tune each of the following base searches to run at a frequency matching your data collection interval:

• TA-ITSI-CITRIX-XD7-AppCrashHang
• TA-ITSI-CITRIX-XD7-DGSessionStats
• TA-ITSI-CITRIX-XD7-GatewayStats
• TA-ITSI-CITRIX-XD7-MCSessionStats
• TA-ITSI-CITRIX-XD7-SessionStats
• TA-ITSI-CITRIX-XD7-VDALoad
• DA-ITSI-WEBSERVER:ActivityClone
• TA-ITSI-CITRIX-XD7-ControllerStats
• TA-ITSI-CITRIX-XD7-DeliveryGroupStats
• TA-ITSI-CITRIX-XD7-HostVDALogonStats
• TA-ITSI-CITRIX-XD7-LaunchFailureStats
• TA-ITSI-CITRIX-XD7-LicensingStats
• TA-ITSI-CITRIX-XD7-MachineCatalogStats
• TA-ITSI-CITRIX-XD7-SiteUserStats

Review and tune KPI thresholds

The KPIs in each service template are tied to the Citrix KPI base searches and have thresholds representing best practices. You must tune these threshold values according to your environment. Use the corresponding linked services to validate your thresholds. For more information, see Configure KPI thresholds in ITSI in the Service Insights manual.

Next steps

Now that your services and entities are configured, it's time to start monitoring your Citrix environment and creating actionable alerts. For more information, see Use the Content Pack for Monitoring Citrix.