Citrix Cloud is a platform that provides cloud services to facilitate the delivery of Citrix technologies. It centralizes control and simplifies the deployment and management of Citrix technologies like Virtual Apps and Desktops, Networking, and more. Citrix Cloud aims to enhance efficiency by managing workloads on any cloud—public, private, or hybrid—thus offering flexibility and scalability to meet various business needs.
Devo collector features
Feature
Details
Feature
Details
Allow parallel downloading (multipod)
not allowed
Running environments
collector server
on-premise
Populated Devo events
table
Flattening preprocessing
no
Allowed source events obfuscation
yes
Data sources
Data source
Description
API endpoint
Collector service name
Devo table
Data source
Description
API endpoint
Collector service name
Devo table
Site Configuration Operations Logs
Site configuration operations involve setting up and maintaining the infrastructure for websites or cloud services. This includes configuring server settings, managing domains, establishing network parameters, and implementing security protocols to ensure optimal performance, scalability, and security.
ConfigLog/Operations/$search
site_config_log_operations
daas.citrix.config.event
System Logs
Citrix Cloud system logs provide detailed records of system activities, helping monitor and troubleshoot the operations of Citrix Cloud services. These logs are essential for auditing, diagnosing issues, and ensuring the secure and efficient functioning of cloud-based resources.
systemlog/records
system_log_operations
daas.citrix.system.event
Check more information about these data tables in this article.
Vendor setup
Set up a BigQuery project for reporting logs - Google Workspace Admin Help
Supported editions for this feature include Frontline Standard, Enterprise Standard and Plus, Education Standard and Plus, and Enterprise Essentials Plus. Compare your edition.
Before you set up BigQuery logs in the Google Admin console, establish a BigQuery project for your reporting logs in the Google Cloud console:
Create an API client
To use APIs, an API client must be created in Citrix Cloud:
Getting the Citrix Cloud region
By default, the collector is configured to use the US region. If you are using a different region, you need to specify it in the collector configuration file. The available regions are:
"us"
"eu"
"aps"
"jp"
Minimum configuration required for basic pulling
Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.
This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.
Setting
Details
Setting
Details
customer_id
The Citrix Cloud customer ID.
client_id
The Citrix Cloud client ID.
client_secret
The Citrix Cloud client secret.
Accepted authentication methods
Authentication method
Customer ID
Client ID
Client secret
Authentication method
Customer ID
Client ID
Client secret
OAuth2
Required
Required
Required
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Collector services detail
This section is intended to explain how to proceed with specific actions for services.
Internal process and deduplication method
All site configuration operation logs are fetched continually based on the EndTime datetime key. The collector stores the last EndTime value and respective log IDs to ensure that no duplicate records are ingested into the Devo table.
Devo categorization and destination
All events of this service are ingested into the table daas.citrix.config.event
2024-05-08T20:42:16.640 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Reading persisted data
2024-05-08T20:42:16.644 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2023-01-10T00:00:00.000000Z', 'last_event_time_in_utc': '2023-01-10T00:00:00.000000Z', 'last_ids': [], 'sites': {'2c7509c3-cb4e-4fd2-b2fc-e71cf324d70b': {'last_event_time_in_utc': '2024-04-16T14:48:09.000000Z', 'last_ids': ['792c7f8c7d7fd46ef53dab3af10b9bf3fe5d79f4dae9722c14ca11305f5eb224']}}, 'next_sites': [], 'next_kwargs': {}}
2024-05-08T20:42:16.645 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Running the persistence upgrade steps
2024-05-08T20:42:16.645 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Running the persistence corrections steps
2024-05-08T20:42:16.646 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Running the persistence corrections steps
2024-05-08T20:42:16.647 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> No changes were detected in the persistence
2024-05-08T20:42:16.647 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) Finalizing the execution of pre_pull()
2024-05-08T20:42:16.647 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Starting data collection every 300 seconds
2024-05-08T20:42:16.648 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Pull Started
2024-05-08T20:42:17.464 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Received 174 records for site cloudxdsite (2c7509c3-cb4e-4fd2-b2fc-e71cf324d70b).
2024-05-08T20:42:17.467 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Sending 174 record(s) to tag 'my.app.citrix_cloud.config_log_operations'
2024-05-08T20:42:17.472 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Sent 174 records for site cloudxdsite (2c7509c3-cb4e-4fd2-b2fc-e71cf324d70b).
2024-05-08T20:42:17.472 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> No more records available. Setting pull_completed to True.
2024-05-08T20:42:17.476 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Updating the persistence
2024-05-08T20:42:17.476 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1715215336638):Number of requests made: 2; Number of events received: 174; Number of duplicated events filtered out: 0; Number of events generated and sent: 174; Average of events per second: 210.142.
2024-05-08T20:42:17.476 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1715215336638):Number of requests made: 2; Number of events received: 174; Number of duplicated events filtered out: 0; Number of events generated and sent: 174; Average of events per second: 210.077.
2024-05-08T20:42:17.477 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> The data is up to date!
2024-05-08T20:42:17.477 INFO InputProcess::ConfigLogOperationsPuller(citrix_cloud,100000,site_config_log_operations,predefined) -> Data collection completed. Elapsed time: 0.839 seconds. Waiting for 299.161 second(s) until the next one
Restart the persistence
This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:
Edit the configuration file.
Change the value of the start_time_in_utc parameter to a different one.
Save the changes.
Restart the collector.
The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.
Internal process and deduplication method
All site configuration operation logs are fetched continually based on the utcTimestamp datetime key. The collector stores the last utcTimestamp value and respective log IDs to ensure that no duplicate records are ingested into the Devo table.
Devo categorization and destination
All events of this service are ingested into the table daas.citrix.system.event
Setup output
2024-05-08T20:50:30.010 INFO InputProcess::MainThread -> SystemLogsPullerSetup(unknown,citrix_cloud#100000,system_logs#predefined) -> Starting thread
2024-05-08T20:50:30.011 INFO InputProcess::MainThread -> SystemLogsPuller(citrix_cloud,100000,system_logs,predefined) - Starting thread
2024-05-08T20:50:30.023 INFO InputProcess::MainThread -> [GC] global: 50.4% -> 50.4%, process: RSS(59.53MiB -> 60.33MiB), VMS(390.79GiB -> 390.79GiB)
2024-05-08T20:50:30.661 INFO InputProcess::SystemLogsPullerSetup(unknown,citrix_cloud#100000,system_logs#predefined) -> Setup for module <SystemLogsPuller> has been successfully executed
Puller output
As the puller operates, periodically partial statistics will be sent to the logs.
Restart the persistence
This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:
Edit the configuration file.
Change the value of the start_time_in_utc parameter to a different one.
Save the changes.
Restart the collector.
The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.
Troubleshooting
This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.
Common logic
Error type
Error ID
Error message
Cause
Solution
InitVariablesError
1
Invalid start_time_in_utc: {ini_start_str}. Must be in parseable datetime format.
The configured start_time_in_utc parameter is a non-parseable format.
Update the start_time_in_utc value to have the recommended format as indicated in the guide.
InitVariablesError
2
Invalid start_time_in_utc: {ini_start_str}. Must be in the past.
The configured start_time_in_utc parameter is a future date.
Update the start_time_in_utc value to a past datetime.
ApiError
401
An error occurred while trying to authenticate with the Azure API. Exception: {e}
The collector is unable to authenticate with the Azure API.
Check the credentials and ensure that the collector has the necessary permissions to access the Azure API.
ApiError
410
An error occurred while trying to check if container {container_name} exists. Ensure that the blob storage account name or connection string is correct. Exception: {e}
The collector was unable to locate the specified blob storage container name.
Ensure the container exists and the credentials have READ access to the container
ApiError
411
An error occurred while trying to check if container {container_name} exists. Ensure that the application has necessary permissions to access the containers. Exception: {e}
The collector was unable to access the specified blob storage container name.
Ensure the container exists and the credentials have READ access to the container
ApiError
412
An error occurred while trying to create container {container_name}. Ensure that the application has necessary permissions to create containers. Exception: {e}
The collector was unable to create the container for the auto discover service and the user indicated to use Azure Blob Storage checkpointing.
Ensure the credentials have WRITE access to the container storage account.
ApiError
420
An error occurred while trying to get consumer group {consumer_group_name}. Exception: {e}
The collector was unable to access the specified consumer group name.
Ensure the consumer group exists and the credentials have READ access to the consumer group
ApiError
421
An error occurred while trying to create consumer group {consumer_group_name}. Ensure that the application has necessary permissions to create consumer groups. Exception: {e}
The collector was unable to create the consumer group for the auto discover service.
Ensure the credentials have WRITE access to the event hub namespace or use the $Default consumer group.
Collector operations
This section is intended to explain how to proceed with specific operations of this collector.
Initialization
The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.
A successful run has the following output messages for the initializer module:
Events delivery and Devo ingestion
The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.
A successful run has the following output messages for the initializer module:
Sender services
The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:
Sender services
Description
Sender services
Description
internal_senders
In charge of delivering internal metrics to Devo such as logging traces or metrics.
standard_senders
In charge of delivering pulled events to Devo.
Sender statistics
Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:
Logging trace
Description
Logging trace
Description
Number of available senders: 1
Displays the number of concurrent senders available for the given Sender Service.
sender manager internal queue size: 0
Displays the items available in the internal sender queue.
This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.
Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": o (elapsed 0.000 seconds)
Displays the number of events from the last time and following the given example, the following conclusions can be obtained:
44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2023-01-10 16:09:16.116750+00:00
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.00 seconds to be delivered.
To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.
The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory
Change log
Release
Released on
Release type
Recommendations
Release
Released on
Release type
Recommendations
v1.2.0
Oct 9, 2024
Improvement
Recommended version
Improvements - Upgrade DCSDK to 1.12.4 - Upgrade Docker base image to 1.3.1 - Upgrade authlib to 1.3.1
