Configuration Logging

May 28, 2016

Configuration Logging captures Site configuration changes and administrative activities to the Database. 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

You set Configuration Logging preferences, display configuration logs, and generate HTML and CSV reports from Citrix Studio. You can filter configuration log displays by date ranges and by full text search results. Mandatory logging, when enabled, prevents configuration changes from being made unless they can be logged. With appropriate permission, you can delete entries from the configuration log. You cannot use the Configuration Logging feature to edit log content.

Configuration Logging uses a PowerShell 2.0 SDK and the Configuration Logging Service. The Configuration Logging Service runs on every Controller in the Site; if one Controller fails, the service on another Controller automatically handles logging requests.

By default, the Configuration Logging feature is enabled, and uses the Database that is created when you create the Site (the Site Configuration Database). Citrix strongly recommends that you you change the location of the database used for Configuration Logging as soon as possible after creating a Site. The Configuration Logging Database supports the same high availability features as the Site Configuration Database.

Access to Configuration Logging is controlled through Delegated Administration, with the Edit Logging Preferences and View Configuration Logs permissions.

Configuration logs are localized when they are created. For example, a log created in English will be read in English, regardless of the locale of the reader.

What is logged

Configuration changes and administrative activities initiated from Studio, Director, and PowerShell scripts are logged. 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
  • Studio or Director sending a message to a user

The following operations are not logged:

  • 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, direct access of the Database, or from sources other than Studio, Director, or PowerShell.
  • When the deployment is initialized, Configuration Logging becomes available when the first Configuration Logging Service instance registers with the Configuration Service. Therefore, the very early stages of configuration are not logged (for example, when the Database schema is obtained and applied, when a hypervisor is initialized).