Troubleshoot StoreFront

Note:

Learn about product name changes in What’s new.

When StoreFront is installed or uninstalled, the following log files are created by the StoreFront installer in the C:\Windows\Temp\StoreFront 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 for debugging

Important:

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 console before opening the StoreFront console.

Trace output is sent to c:\Program Files\Citrix\Receiver StoreFront\admin\trace

Trace output

Note:

Run Get-Help Set-STFDiagnostics -detailed to obtain Powershell help and instructions on how to use the Set-STFDiagnostics cmdlet.

Use an account with local administrator permissions to start Windows PowerShell and, at a command prompt, specify the following mandatory parameters to enable or disable tracing.

  • -All. A flag indicating that tracing should be updated for all instances and services.
  • -TraceLevel. In increasing levels of tracing detail, allowed values for -TraceLevel are: Off, Error, Warning, Info, or Verbose. Due to the large amount of data that can be generated, tracing may significantly impact the performance of StoreFront. The Info or Verbose levels are not recommended unless specifically required for troubleshooting.

Optional parameters:

  • -FileSizeKb. The trace file size in KB.
  • -FileCount. The number of trace files to maintain on disk at a time.
  • -confirm:$False. Suppresses Windows prompts to allow the StoreFront cmdlet to run each time.

Examples

To enable Verbose level tracing for all service for debugging purposes:

Set-STFDiagnostics -All -TraceLevel "Verbose" -confirm:$False

To disable Verbose level tracing, and set the tracing level back to the default value for all services:

Set-STFDiagnostics -All -TraceLevel "Error" -confirm:$False

For more information on the Set-STFDiagnostics cmdlet, see the StoreFront PowerShell SDK documentation.

To enable logging of the launch.ica file

Save the information in the launch.ica file to the client computer to troubleshoot multiple issues. The launch.ica file is generated by Citrix Web Interface or Citrix StoreFront Servers.

To enable logging of the launch.ica file, complete the following steps:

  1. Navigate to the following registry key by using the registry editor:

    32-bit Systems: HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\Logging

    64-bit Systems: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\Logging

  2. Set the following two string key values:

    • LogFile=”path to the log file”
    • LogICAFile=true

    For example:

    LogFile=C:\ica\ica.log
    LogICAFile=true
    

Additional resources

Note:

The use of an ICA file in your environment for anything other than troubleshooting purposes is further outlined in CTX200126.

Troubleshoot StoreFront upgrade issues

Use the following steps to troubleshoot StoreFront upgrade issues.

Before attempting an upgrade

  1. Confirm that you have a backup of all StoreFront servers.
  2. Verify that you are not attempting to upgrade from an End of Life StoreFront version. For more information see CTX200356.
  3. Verify that you are upgrading from a supported version of StoreFront to the current version only.
  4. If the StoreFront server is part of a StoreFront server group, all servers in the group must be upgraded sequentially. Simultaneously upgrading a StoreFront server group is not supported.
  5. Delete any thumbs.db files inside C:\inetpup\wwwroot\citrix or its subdirectories. Show hidden files to complete this step: Folder Options > View, choose option Show hidden files, folders and drives and clear the option Hide protected operating system files (Recommended).
  6. Disable antivirus software before starting the upgrade procedure.
  7. Confirm that servers being upgraded are removed from any load balancer, and that they have no active user sessions connected.
  8. Reboot the StoreFront server before performing the upgrade.
  9. Manually stop the following Services:
    • CitrixConfigurationReplication
    • CitrixCredentialWallet
    • CitrixDefaultDomainService
    • CitrixPeerResolutionService
    • CitrixSubscriptionsStore
  10. Ensure that the StoreFront management console is closed.

If the upgrade fails

  1. In C:\Windows\Temp\StoreFront, open the latest CitrixMsi*.log and search for any exception errors.

    Thumbs.db Access exceptions: caused by thumbs.db files inside C:\inetpup\wwwroot\citrix or in its subdirectories. Delete any thumbs.db files found.

    Cannot get exclusive file access \in use exceptions: restore the snapshot/backup if available, or restart the server, and manually stop any StoreFront services.

    Service cannot be started exceptions: restore the snapshot/backup if available, or install the full version of .NET framework 4.5 (not client profile).

  2. If there are no exception errors in CitrixMsi*.log, check the server’s Event Viewer > Delivery Services for any errors containing the preceding exception error messages. Follow the corresponding advice.
  3. If there are no exception errors in the Event Viewer, check the Admin logs in C:\Program Files\Citrix\Receiver StoreFront\logs for any errors containing the preceding exception error messages. Follow the corresponding advice.

To manually remove StoreFront

Warning:

Manually removing StoreFront clears all existing information.

To manually remove StoreFront:

  1. Uninstall StoreFront.
  2. Remove Web Server Role.
  3. Delete the folder C:\Program Files\Citrix\Receiver StoreFront.
  4. Delete any subdirectories under C:\Program Files\Citrix\StoreFront Install.
  5. Delete the folder C:\Inetpub.

You can now reinstall StoreFront.