Viewing Configuration Logging Data Not Shown in Citrix Studio
Article ID: CTX138132
Updated On:
Description
This article provides an overview of Configuration Logging and the Configuration Logging screen in Citrix Studio. It also explains how to access Configuration Logging data that is not shown in Citrix Studio.
Configuration Logging Overview
Operations that affect site configuration, which are made by the consoles and services are recorded by the Configuration Logging system. The resulting logs can be viewed in the Citrix Studio Logging screen, as displayed in the following screen shot:
-
The upper panel of the Logging screen shows data from high-level operation logs.
A high-level operation represents a configuration change initiated from Citrix Studio, Citrix Director, or a PowerShell Script.
-
The lower panel shows data from low-level operation logs.
A low-level operation represents a configuration change executed by a XenDesktop service, in order to fulfil a high-level operation.
Logging Data Shown in Citrix Studio
The Citrix Studio Logging screen shows a subset of the logging data that is present in the high level and low-level operation logs.
-
For high-level logs, the data shown is:
- The description of the configuration change operation.
- The identity of the administrator that carried out the operation.
- The start and end times of the operation.
- The status of the operation, this is whether it was successful, failed or is still in progress.
- For low-level logs, the data shown is:
- The description of the configuration change operation.
- The identity of the administrator that carried out the operation.
- The start and end times of the operation.
- The status of the operation, this is whether it was successful, failed or is still in progress.
You can view additional data not shown on the Logging screen by:
- Generating an HTML configuration logging report.
- Retrieving the logs through the configuration logging service SDK.
Viewing Logging Data in HTML Reports
An HTML report can be generated by performing the Create Custom Report action from the Citrix Studio Logging screen. This will generate the following two html report files:
- Summary.html: This contains summary information from high-level operation logs.
- Details.html: This contains detailed information from low-level operation logs.
Summary HTML Report
The summary.html report (see the following screen shot) essentially contains the high-level logging data as shown in Citrix Studio.
Hyperlinks in summary.html allows you to navigate into details.html to view details about the low-level logs associated with the high-level operations.
Details.html includes additional information about low-level operations, such as:
- The list of cmdlet parameters supplied when the service SDK operation was executed.
- The names of object(s) affected by the configuration change. For example, the name of a hypervisor connection or the name of a Catalog.
- The type of object(s) affected by the configuration change. For example, HypervisorConneciton or Catalog.
Retrieving Logging from the Configuration Logging PowerShell SDK
Cmdlet Get-LogHighLevelOperation can be used to retrieve high-level operation logs. Cmdlet Get-LogLowLevelOperation can be used to retrieve low-level operation logs.
The SDK objects returned by these cmdlets include further details, such as:
- The IP address of the machine that the operation was performed on.
- The identifier of the XenDesktop service, which performed the operation. For example, Admin, Host.
- The unique identifier of each object affected by the operation. For example, the identifier of a renamed Catalog, or a Desktop Group that was put into maintenance mode.
- Old and new values for object properties that were changed (if the logged operation involved changes to object properties).
Refer to PowerShell SDK help for information on usage of these cmdlets, and details on returned SDK object properties.
Issue/Introduction
