Product Documentation

Troubleshoot StoreFront

May 22, 2017

When StoreFront is installed or uninstalled, the following log files are created by the StoreFront installer in the C:\Windows\Temp\ directory. The file names reflect the components that created them and include time stamps.

  • Citrix-DeliveryServicesRoleManager-*.log—Created when StoreFront is installed interactively.
  • Citrix-DeliveryServicesSetupConsole-*.log—Created when StoreFront is installed silently and when StoreFront is uninstalled, either interactively or silently.
  • CitrixMsi-CitrixStoreFront-x64-*.log—Created when StoreFront is installed and uninstalled, either interactively or silently.

StoreFront supports Windows event logging for the authentication service, stores, and Receiver for Web sites. Any events that are generated are written to the StoreFront application log, which can be viewed using Event Viewer under either Application and Services Logs > Citrix Delivery Services or Windows Logs > Application. You can control the number of duplicate log entries for a single event by editing the configuration files for the authentication service, stores, and Receiver for Web sites.   

The Citrix StoreFront management console automatically records tracing information. By default, tracing for other operations is disabled and must be enabled manually. Logs created by Windows PowerShell commands are stored in the \Admin\logs\ directory of the StoreFront installation, typically located at C:\Program Files\Citrix\Receiver StoreFront\. The log file names contain command actions and subjects, along with time stamps that can be used to differentiate command sequences.

Important: In multiple server deployments, use only one server at a time to make changes to the configuration of the server group. Ensure that the Citrix StoreFront management console is not running on any of the other servers in the deployment. Once complete, propagate your configuration changes to the server group so that the other servers in the deployment are updated.

To configure log throttling

  1. Use a text editor to open the web.config file for the authentication service, store, or Receiver for Web site, which are typically located in the C:\inetpub\wwwroot\Citrix\Authentication\, C:\inetpub\wwwroot\Citrix\storename\, and C:\inetpub\wwwroot\Citrix\storenameWeb\ directories, respectively, where storename is the name specified for the store when it was created.
  2. Locate the following element in the file.
    <logger duplicateInterval="00:01:00" duplicateLimit="10">

    By default, StoreFront is configured to limit the number of duplicate log entries to 10 per minute.

  3. Change the value of the duplicateInterval attribute to the set the time period in hours, minutes, and seconds over which duplicate log entries are monitored. Use the duplicateLimit attribute to set the number of duplicate entries that must be logged within the specified time interval to trigger log throttling.

When log throttling is triggered, a warning message is logged to indicate that further identical log entries will be suppressed. Once the time limit elapses, normal logging resumes and an informational message is logged indicating that duplicate log entries are no longer being suppressed.

To enable tracing

Caution: The StoreFront and PowerShell consoles cannot be open at the same time. Always close the StoreFront admin console before using the PowerShell console to administer your StoreFront configuration. Likewise, close all instances of the PowerShell before opening the StoreFront console.
  1. Use an account with local administrator permissions to start Windows PowerShell and, at a command prompt, type the following commands and restart the server to enable tracing.
    Add-PSSnapin Citrix.DeliveryServices.Framework.Commands 
     
    Set-DSTraceLevel -All -TraceLevel Verbose
    

    Allowed values for -TraceLevel are, in increasing levels of tracing detail: Off, Error, Warning, Info, Verbose.
    StoreFront automatically captures Error trace messages. Due to the large amount of data that can potentially be generated, tracing may significantly impact the performance of StoreFront, so it is recommended that the Info or Verbose levels are not used unless specifically required for troubleshooting.

    Optional arguments for the Set-DSTraceLevel cmdlet are:
    -FileCount: Specifies the number of trace files (default = 3)
    -FileSizeKb: Specifies the maximum size of each trace file (default = 1000)
    -ConfigFile <FileName>: An alternative to -All that allows a specific configuration file to be updated rather than all.  For example, a -ConfigFile value of c:\inetpub\wwwroot\Citrix\<StoreName>\web.config would set tracing for the Store with the name <StoreName>.

  2. To disable tracing, type the following commands and restart the server.
    Add-PSSnapin Citrix.DeliveryServices.Framework.Commands 
     
    Set-DSTraceLevel -All -TraceLevel Off
    

When tracing is enabled, tracing information is written in the \Admin\Trace\ directory of the StoreFront installation located at C:\Program Files\Citrix\Receiver StoreFront\.