How to Enable StoreFront Verbose Logging

How to Enable StoreFront Verbose Logging

book

Article ID: CTX139592

calendar_today

Updated On:

Description

This article explains how to use PowerShell to enable the native verbose logging and how to use Microsoft’s DebugView tool to collect traces.

Requirements

  • Basic knowledge of PowerShell

Instructions

When using StoreFront 2402 and higher, by default, StoreFront logs sufficient information to be able to resolve many issues. You can enable additional verbose logging for troubleshooting purposes. This is only required if requested by Citrix support. This may have an impact on performance so you should revert the TraceLevel to Info once troubleshooting is complete.

When using StoreFront 2203 CU4 and earlier, StoreFront by default only logs errors. To get more complete logs for troubleshooting, you must manually enable verbose logging.

Warning: changing the logging level will restart the Storefront services which will make StoreFront temporarily unavailable and log out any users.

  1. Open PowerShell as an administrator

  2. To use the default file size and circular logging, execute command: 

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

    Using StoreFront 2203 CU5 or higher, by default for each service it it logs up to 5 log files of 200MB per file which is generally sufficient. If using earlier versions of StoreFront, or you need to change the file size, you can do this using the -FileCount and FileSizeKb parameters, for example:

    Set-STFDiagnostics -All -TraceLevel "Verbose" -FileCount 5 -FileSizeKb 200000 -confirm:$False
  3. When this command is entered it will restart the Storefront services.  Wait for the PowerShell prompt to return to verify that that the services have finished restarting.
    Note: When these services are restarting, the StoreFront server will not be accessible by users.

    • Citrix Configuration Replication

    • Citrix Credential Wallet

    • Citrix Default Domain Services

    • Citrix Peer Resolution Service

    • Citrix Subscriptions Store

  4. Reproduce the issue to create the logs. Note the time at which you started and stopped steps to reproduce.

  5. Set the logging back to default.  On StoreFront 2203 CU5 and higher, the default log level is "Info":
    Set-STFDiagnostics -All -TraceLevel "Info" -confirm:$False
    Or on StoreFront 2203 CU4 and earlier the default log level is "Error":
    Set-STFDiagnostics -All -TraceLevel "Error" -confirm:$False

  6. Collect the files from C:\Program Files\Citrix\Receiver Storefront\Admin\Trace. Only include log files relating to the period you reproduced the error. You may wish to further reduce the file size by deleting log entries prior to and after the period where you reproduced the error.

  7. Zip all the files into a single .zip file. Upload to your case number at https://CIS.CITRIX.COM or to https://support.citrix.com/case/manage 



Alternative: Use DebugView

As an alternative to capturing the log files, you can ​​​​​​​use DebugView. This has the advantage that it is easier to capture just the period of time during which you reproduced the steps. However this contains less information than the log files so it is not recommended.

  1. Download DebugView Tool by Microsoft.

  2. Extract the files from the zip file, and run Dbgview.exe.

  3. Click Capture menu and select Capture Global Win32.

  4. Click Options menu and select Clock Time. This will allow to view the clock time instead of seconds from the start of trace, making it easy to analyze any logs.

  5. Enable verbose logging as the above instructions
  6. Clear the capture just before you start reproducing the error.
  7. Reproduce the issue.

  8. Press the capture toolbar button to stop capture.
  9. In DebugView, click File Save As to save the captured output to a .log file.

  10. Zip up the .log file and upload to your case number at https://CIS.CITRIX.COM or to https://support.citrix.com/case/manage.

Environment

Citrix is not responsible for and does not endorse or accept any responsibility for the contents or your use of these third party Web sites. Citrix is providing these links to you only as a convenience, and the inclusion of any link does not imply endorsement by Citrix of the linked Web site. It is your responsibility to take precautions to ensure that whatever Web site you use is free of viruses or other harmful items.

Issue/Introduction

This article explains two different wasy to collect diagnostic traces from Storefront server.

Additional Information