The Citrix Session Monitoring connector retrieves data from the Citrix Cloud Monitor Service API endpoints. The data is collected based on the configured parameters and stored in two tables.
API Endpoints
The connector queries the following Citrix Monitor Service OData endpoints:
Sessions Endpoint
Endpoint: |
https://api.cloud.com/monitorodata/Sessions |
Description: |
Retrieves session information with expanded properties for connections, users, and machines. Collects VDI inventory and usage data including session timing, user details, machine specifications, and infrastructure information. |
Documentation: |
Application Instances Endpoint
Endpoint: |
https://api.cloud.com/monitorodata/ApplicationInstances |
Description: |
Retrieves application instance data with expanded session, machine, and user details. Collects XenApp usage data including application names, user sessions, and usage timestamps. |
Documentation: |
Machines Endpoint
Endpoint: |
https://api.cloud.com/monitorodata/Machines |
Description: |
Retrieves detailed machine information including catalog, hypervisor, and cost specifications. This endpoint is queried for each session to enrich the data with infrastructure details. |
Documentation: |
Data Filtering
The connector applies OData filter expressions to limit the data retrieved:
•Time-based Filtering: Sessions and application instances are filtered based on the StartDate field using the fetchStartDatePeriod parameter.
•Expand Queries: Related entities (User, Machine, Connection, Application) are expanded to retrieve nested data in a single request where possible.
Result Tables
The connector creates two CSV result tables:
historical_sessions
Contains VDI session data. This table is created when fetchSessions is enabled.
•Data Source: /monitorodata/Sessions and /monitorodata/Machines
•Row Count: One row per session within the specified time period
•Key Fields: Session ID, start/end timestamps, user information, machine details, hypervisor, cloud region
For detailed column information, see Tables.
historical_application_sessions
Contains XenApp application usage data. This table is created when fetchApplicationInstances is enabled.
•Data Source: /monitorodata/ApplicationInstances
•Row Count: One row per application instance within the specified time period
•Key Fields: Session key, application name, published name, start/end timestamps, user information
For detailed column information, see Tables.
|
Data Deduplication: The connector automatically removes duplicate records before writing data to CSV files. This ensures data quality and prevents redundant entries in the result tables. |
