Product Documentation

Manage Configuration Logging

Sep 06, 2013

By default, Configuration Logging is enabled, and mandatory logging is disabled.

By default, Configuration Logging uses the database that is created when you create a Site (also known as the Site Configuration Database). Citrix recommends that you change the location of the database used for Configuration Logging (and the database used for the Monitoring Service, which also uses the Site Configuration Database by default) after creating a Site, for the following reasons:
  • The backup strategy for the Configuration Logging Database is likely to differ from the backup strategy for the Site Configuration Database.
  • The volume of data collected for Configuration Logging (and the Monitoring Service) could adversely affect the space available to the Site Configuration database.
  • It splits the single point of failure for the three databases.

For more information, see Change secondary database locations.

The Configuration Logging Database supports the same high availability features as the Site Configuration Database. Review the database guidance in Plan a deployment.

To enable/disable Configuration Logging and mandatory logging

  1. From Citrix Studio, select Logging in the left pane.
    Note: Editions that do not support Configuration Logging do not have a Logging node.
  2. In the Actions pane, click Preferences. The Configuration Logging dialog box appears, displaying database information and whether Configuration Logging and mandatory logging are enabled or disabled.
    • To enable or disable Configuration Logging:
      • To enable Configuration Logging, select the Enable logging radio button. This is the default setting. If the database cannot be written to, the logging information is discarded, but the operation continues.
      • To disable Configuration Logging, select the Disable logging radio button. If logging was previously enabled, existing logs remain readable with the PowerShell SDK.
    • To enable or disable mandatory logging:
      • To enable mandatory logging, clear the Allow changes when the database is disconnected checkbox. No configuration change or administrative activity that would normally be logged will be allowed unless it can be written in the database used for Configuration Logging.
      • To disable mandatory logging, select the Allow changes when the database is disconnected checkbox. Configuration changes and administrative activities are allowed, even if the database used for Configuration Logging cannot be accessed. This is the default setting.

      The mandatory logging option is available only when Configuration Logging is enabled, that is, when the Enable Configuration Logging radio button is selected. If the Configuration Logging Service fails, and high availability is not in use, mandatory logging is assumed. In such cases, operations that would normally be logged are not performed.

To change the Configuration Logging Database location

  1. Create a database server, using a supported SQL Server version.
  2. From Studio, select Logging in the left pane.
  3. In the Actions pane, click Preferences. The Configuration Logging dialog box appears.
  4. Click Change logging database. The Change Configuration Logging Database dialog box appears.
  5. Specify the location of the server containing the new database server (using one of the forms in the following table) and the database name.
    Database type What to enter With this database configuration
    Standalone or mirror servername The default instance is used and SQL Server uses the default port.
      Servername\INSTANCENAME A named instance is used and SQL Server uses the default port.
      servername,port-number The default instance is used and SQL Server uses a custom port. (The comma is required.)
    Other cluster-name A clustered database.
      availability-group-listener An Always-On database.
  6. If you want Studio to create the database, click OK or Test connection. When prompted, click OK, and Studio will create the database automatically. Studio attempts to access the database using the current Studio user's credentials; if that fails, you are prompted for the database user's credentials. Studio then uploads the database schema to the database. (The credentials are retained only for the database creation time frame.)
  7. If you want to create the database manually, click Generate script (or use Get-LogDBSchema in the PowerShell SDK). The generated script includes instructions for manually creating the database. Ensure that the database is empty and that at least one user has permission to access and change the database before uploading the schema.

The Configuration Logging data in the previous database is not imported to the new database. Logs cannot be aggregated from both databases when retrieving logs. The first log entry in the new Configuration Logging Database will indicate that a database change occurred, but it does not identify the previous database.