Citrix Gateway data source
If you have subscribed to Citrix Application Delivery Management (ADM) service that is offered on Citrix Cloud, Citrix Analytics automatically discovers the agents and Gateway instances added to ADM. You have to enable Analytics to allow Citrix Analytics to begin processing data for the Gateway instances.
If you are not subscribed to Citrix ADM or if you want to add more Gateway data sources, you have to add them from the Analytics service.
This article walks you through the procedures to enable Analytics in both the scenarios.
Enable Analytics on Gateway data sources added to Citrix ADM
You must subscribe to Citrix ADM. To learn how to get started with Citrix ADM, see Getting Started.
Citrix Analytics automatically discovers the agents and the Citrix Gateway instances that are added to Citrix ADM. To view the data source, do one of the following:
Click Get Started on the Analytics Welcome page.
Click Settings > Data Sources > Security.
Discovered agents are displayed as site cards on the Data Sources page. Click Turn On Data Processing to allow Citrix Analytics to begin processing data for this data source.
After you have enabled data processing, the site card might display the No data received status. This happens when the events take some time to reach the event hub in Citrix Analytics. When Citrix Analytics receives the events, the status changes to Data processing on.
If the status does not change after some time, refresh the Data Sources page.
The site card displays the number of Gateway users, agents, and the received events based on the selected time period- 1 hour (1H) or 1 week (1W). Click the number of users and agents to view for this data source.
If no events are received for the last one hour, the Data processing on status changes to No data received. Although there might be some events received for the last one week.
Turn on or off data processing
To stop data processing, click the vertical ellipsis (⋮) on the site card and then click Turn off data processing. Citrix Analytics stops processing data for this data source.
To enable data processing again, click Turn On Data Processing.
Enable Analytics on Gateway data sources not added to Citrix ADM
If you are not subscribed to Citrix ADM or if you want to add more Gateway data sources, add them from the Analytics service.
You need to do the following:
After signing in to Citrix Analytics, click Get Started on the Analytics Welcome page or navigate to Settings > Data Sources > Security.
If no agents are configured on Citrix ADM, you see the 0 discovered agents on the site card. Click + to add agents and Gateway Instances.
Or if you want to add more Gateway data sources, click the agents on the site card to view the Discovered Agents page. From the Add On-Premises Data Sources tile, click Citrix Gateway.
Then, click Get Started on the following page.
Install and set up an agent
Install and configure the Citrix ADM service agent in your network environment to enable communication between Citrix Analytics and the instances in your data center.
You can install an agent on the following hypervisors in your enterprise data center:
Linux KVM Server
To install and set up an agent, do the following:
Download agent image.
On the Set up agent on a hypervisor page, select the hypervisor, and click Download Image to download the agent image to your local system.
Copy service URL and activation code.
A service URL and an activation code are generated and displayed on the UI as shown in the image below. (This might take a few seconds.) The agent uses the service URL to locate the service and the activation code to register with the service. You have to enter the service URL and the activation code while installing the agent on your hypervisor.
Install the agent on a hypervisor.
Before you begin agent installation, ensure that:
You have the required virtual computing resources that the hypervisor must provide for each agent: RAM: 8 GB, vCPU:4, storage space: 120 GB, virtual network interface: 1, and throughput: 1 Gbps
You configure your DNS to allow internet access to your agent.
On Citrix Hypervisor, perform the following:
Import the agent image file to your hypervisor. From the Console tab configure the initial network configuration options as shown in the following example.
If you have entered incorrect values or want to change any value, log on to the shell prompt by using the default credentials
nsroot, and then run the command
Enter the Service URL and the Activation Code that you saved when you had downloaded the agent image.
If you entered the service URL or the activation code incorrectly, log on to the shell prompt of the agent and then run the script:
deployment_type.py. This script lets you reenter the Service URL and activation code.
On VMware ESXi hypervisor, perform the following:
After you configure the network, when prompted, log on to the shell prompt of the agent using the default credentials
Navigate to /mps directory, run the script, and enter the Service URL and the Activation Code that you saved when you had downloaded the agent image.
You can use the same image file to install multiple agents. However, you cannot use the same activation code on more than one agent. To generate a new activation code, access Citrix Analytics, and on the Setup agent on a hypervisor step, click Download Image again. A new activation code is generated.
After agent registration is successful, the agent restarts to complete the installation process. After the agent has restarted, access Citrix Analytics and click Register Agent, and then verify the status of the agent.
When the agent status is in the UP state denoted by a green dot next to it, click Next to start adding instances to the service.
Add Citrix Gateway instances
Instances are Citrix Gateway appliances or virtual appliances that are the data sources for Citrix Analytics.
On the Add Citrix Gateway Instances page, select the instance type and specify host names or IP Addresses or range of IP addresses of Gateway instances to discover.
Create an authentication profile that the agent can use to access the Gateway instances. This profile is the administrator credentials of a Gateway instance. Then, click Add Instances.
After the instances are added, you can view the number of instances that have been successfully discovered. To add more instances, click Add Citrix Gateway Instance.
Click Next to enable analytics.
Citrix Analytics automatically discovers the licensed virtual servers on the added Citrix Gateway Instances. You must enable analytics on all the discovered virtual servers.
On the Enable Analytics page, by default, all the licensed virtual servers from the Gateway instances appear. Review the list of licensed virtual servers and click Enable Analytics to enable analytics on the virtual servers.
The status of the site card changes to Data Processing On. You can view the received events.
Manage data source
You can also add more instances to an agent or remove instances associated with an agent. You can also remove the agent and it’s associated instances from Citrix Analytics.
Flip an agent site card and do one of the following:
Add or Remove instances. You can add more Gateway instances to an agent and enable Analytics on the virtual servers configured on those instances. You can also remove instances added to an agent. When you dissociate an instance from an agent, Citrix Analytics cannot communicate with that instance.
Remove from Citrix Analytics. After you remove an agent site, Citrix Analytics stops collecting data from the instances associated with that agent. But all the previously processed data is available during the retention period.