Connects to the Citrix Cloud Monitor Service API to retrieve session and application usage data from Citrix Virtual Apps and Desktops (CVAD) and Citrix DaaS (Desktop as a Service) environments.
Overview
The Citrix Session Monitoring connector collects historical session and application usage data from Citrix Cloud environments. This connector is particularly useful for organizations that have migrated from Citrix OnPremises to Citrix Cloud and need to maintain visibility into:
•VDI Inventory: Virtual desktop information including machine details, hypervisor, and hosting configuration.
•VDI Usage Information: User session data with timestamps for tracking virtual desktop usage patterns.
•XenApp Usage: Application instance data including user, application name, and last usage timestamps.
Prerequisites
Before configuring the connector, ensure you have:
•A Citrix Cloud account with administrative access.
•API access credentials (Client ID and Client Secret) from Citrix Cloud.
•Your Citrix Cloud Customer ID.
•Network connectivity from the Data Hub Agent to Citrix Cloud API endpoints.
Authentication
The connector uses OAuth 2.0 authentication with Citrix Cloud. You need to provide:
•Client ID: The API client identifier from Citrix Cloud.
•Client Secret: The API client secret (stored securely, masked in the UI).
•Customer ID: Your Citrix Cloud customer identifier.
•Base URL: The Citrix Cloud API endpoint (default: https://api.cloud.com).
|
Note: For Citrix Cloud Japan customers, use the base URL https://api.citrixcloud.jp. |
Configuration Parameters
The connector supports the following configuration options:
Functional Parameters
Parameter |
Description |
Default |
|---|---|---|
fetchSessions |
Activates fetching of session information. When enabled, collects VDI inventory and usage data including connection details, user information, machine specifications, and cloud resource information. |
true |
fetchApplicationInstances |
Activates fetching of application instance information. When enabled, collects XenApp usage data including application names, user sessions, and usage timestamps. |
true |
fetchStartDatePeriod |
Specifies the number of days (from the current date) for which to fetch historical data. Valid range: 1-180 days. |
7 days |
Technical Parameters
Parameter |
Description |
Default |
|---|---|---|
request_timeout |
Request timeout in seconds. If data fetching takes too long and the task fails, increase this value. Minimum: 30 seconds. |
60 seconds |
|
Note: Enabling both fetchSessions and fetchApplicationInstances will significantly increase data extraction time. The connector implements exponential backoff retry logic to handle API rate limiting (HTTP 429 errors). |
API Endpoints
The connector queries the following Citrix Monitor Service OData endpoints:
•/monitorodata/Sessions - Retrieves session information with expanded properties for connections, users, and machines.
•/monitorodata/ApplicationInstances - Retrieves application instance data with expanded session, machine, and user details.
•/monitorodata/Machines - Retrieves detailed machine information including catalog, hypervisor, and cost specifications.
Data Collection
The connector creates two result tables:
•historical_sessions - Contains VDI session data including session timing, user details, machine specifications, and infrastructure information.
•historical_application_sessions - Contains XenApp application usage data including application names, session timing, and user information.
For detailed column information, see Tables.
Performance Considerations
The connector implements the following performance optimizations:
•Split Query Strategy: Due to API limitations with deeply nested expand queries, the connector splits complex queries into multiple simpler requests to avoid timeout errors.
•Exponential Backoff: Implements automatic retry logic with exponential backoff (1s, 2s, 4s, 8s) when encountering API rate limits (HTTP 429) or temporary server errors (HTTP 500).
•Token Reuse: OAuth tokens are reused throughout their lifetime to minimize authentication overhead and avoid rate limiting.
•Data Deduplication: Automatically removes duplicate records before writing to CSV files.
|
Important: Large environments with many sessions or applications may experience longer extraction times. Consider adjusting the fetchStartDatePeriod parameter to fetch smaller time windows, or disable fetchSessions or fetchApplicationInstances if only specific data is needed. |
