Configuration Logging captures Citrix Virtual Apps and Desktops deployment configuration changes and administrative activities to a logging database in Citrix Cloud. You can use the logged content to:
- Diagnose and troubleshoot problems after configuration changes are made. The log provides a breadcrumb trail.
- Assist change management and track configurations.
- Report administration activity.
From Studio, you can view configuration log content, filtered by date ranges or by full text search. You can also generate a CSV report using PowerShell. From Studio, you cannot edit or delete log content. You can use the Remote PowerShell SDK to schedule periodic data deletion from the log.
Configuration logs are localized when they are created. For example, a log created in English is read in English, regardless of the locale of the reader.
Permissions required (see Delegated Administration):
- Full Administrators in Citrix Cloud, plus Citrix Virtual Apps and Desktops service Cloud Administrators and Read Only Administrators can view configuration logs in Studio.
- Full Administrators and Cloud Administrators can also download a CSV report of logging activity, using PowerShell.
What is logged
Configuration changes and administrative activities initiated from the service’s Studio (Manage), Director (Monitor), and PowerShell scripts are logged. However, you cannot see log entries for Citrix Cloud platform internal operations, such as database setup and management.
Examples of logged configuration changes include working with (creating, editing, deleting, assigning):
- Machine catalogs
- Delivery Groups (including changing power management settings)
- Administrator roles and scopes
- Host resources and connections
- Citrix policies through Studio
Examples of logged administrative changes include:
- Power management of a virtual machine or a user desktop
- Manage or monitor functions sending a message to a user
The following operations are not logged. (Many are not available to customer administrators.)
- Autonomic operations such as pool management power-on of virtual machines.
- Policy actions implemented through the Group Policy Management Console (GPMC). Use Microsoft tools to view logs of those actions.
- Changes made through the registry or from sources other than Studio (Manage), Director (Monitor), or PowerShell.
Display configuration log content
- Sign in to Citrix Cloud. Select Virtual Apps and Desktops in the upper left menu.
- Select the Manage tab.
- Select Logging in the Studio navigation pane.
By default, the display in the center pane lists the log content chronologically (newest entries first), separated by date. You can:
- Sort the display by column heading.
- Filter the display by specifying a day interval, or entering text in the Search box. To return to the standard display after using search, clear the text in the Search box.
- High-level operations created during management and monitoring are listed in the upper middle pane in Studio. A high-level operation results in one or more services and PowerShell SDK calls, which are low-level operations. When you select a high-level operation in the upper middle pane, the lower pane displays the low-level operations.
- If you create a low-level operation in PowerShell without specifying a parent high-level operation, Configuration Logging creates a surrogate high-level operation.
- If an operation fails before completion, the log operation might not be completed in the database. For example, a start record will have no corresponding stop record. In such cases, the log indicates that there is missing information. When you display logs based on time ranges, incomplete logs are shown if the data in the logs matches the criteria. For example, if logs for the last five days are requested, and a log with a start time in the last five days has no end time, it is included.
- Remember: You cannot see log entries for Citrix Cloud platform internal operations, such as database setup and management.
To generate a report containing configuration log data, use PowerShell cmdlets for the ConfigLogging Service in the Citrix Virtual Apps and Desktops Remote PowerShell SDK. For example, you can retrieve a filtered list of high-level or low-level operations. For details, see SDKs and APIs and Citrix Virtual Apps and Desktops SDK.
Schedule periodic data deletion
Use the Remote PowerShell SDK to specify how long data is retained in the Configuration Logging database. (This feature is not available in the Studio management console.) In the Citrix Virtual Apps and Desktops service, you must have Full access.
Set-LogSite cmdlet, the
-LoggingDBPurgeDurationDays parameter specifies how many days data in the Configuration Logging database is retained before it is deleted automatically.
- By default, the value of this parameter is 0. A zero value means that data in the Configuration Logging database is never deleted automatically.
- When you set a non-zero value, the database is checked once every 120 minutes. Data older than the retention period is deleted.
Get-LogSite to view the current value of the parameter.
Differences from on-premises Citrix Virtual Apps and Desktops
If you’re familiar with Configuration Logging in the on-premises Virtual Apps and Desktops product, the Citrix Cloud version has several differences. In Citrix Cloud:
- Configuration Logging is always enabled. You cannot disable it. Mandatory logging is not available.
- You cannot change the location of the Configuration Logging database, because the database is managed in the Citrix Cloud platform, and is accessible by customer administrators.
- Configuration log displays do not include operations and activities that are performed within the Citrix Cloud platform.
- You can create a CSV report of logged operations using PowerShell cmdlets only. In the on-premises product, CSV or HTML reports can be generated from Studio or PowerShell.
- You cannot delete configuration log content.