How to collect diagnostics on issues with the default publishing


Overview

This article contains steps for collecting diagnostics information on publishing issues which is required when contacting Sitecore Support. 

How to collect diagnostics information

  1. Set up verbose logging for publishing.
    To enable the feature create a configuration file with the following contents and place it in the /App_Config/Include/zzz folder for the publishing instance: 
    <?xml version="1.0" encoding="utf-8" ?>
    <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:set="http://www.sitecore.net/xmlconfig/set/" xmlns:role="http://www.sitecore.net/xmlconfig/role/">
        <sitecore>
            <pipelines>
                <publishItem role:require="Standalone or ContentManagement" >
                    <processor type="Sitecore.Publishing.Pipelines.PublishItem.UpdateStatistics, Sitecore.Kernel" runIfAborted="true">
                        <traceToLog>true</traceToLog>
                    </processor>
                </publishItem>    
            </pipelines>
        </sitecore>
    </configuration>
  2. Enable logging of start and end time for each event and event handler. To enable the feature create a configuration file with the following contents and place it in the /App_Config/Include/zzz folder for the Content Delivery instances: 
    <?xml version="1.0" encoding="utf-8" ?>
    <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:set="http://www.sitecore.net/xmlconfig/set/" xmlns:role="http://www.sitecore.net/xmlconfig/role/">
        <sitecore>
            <events set:timingLevel="high" role:require="Standalone or ContentDelivery"/>
        </sitecore>
    </configuration>
  3. Capture and save network requests for the page that is about to be modified. 
    To capture and save the results, use the developer tools integrated in the browser, for example, https://developer.chrome.com/docs/devtools/network/reference#save-as-har.
    Make sure the requested page is not cached, for example, https://developer.chrome.com/docs/devtools/network/reference#disable-cache
    Alternatively, you can use a web debugging proxy, like Telerik Fiddler.
  4. Collect an on-demand memory dump file for a CD instance. For detailed instructions, see how to collect memory dumps.
  5. Modify the item that affects presentation for the page from step 3. Publish the changes done.
  6. Wait for the publishing operation to complete.
    If the publish operation takes longer than expected, then capture 3 memory dump files for the publishing instance. The interval between the memory dump files should be under 2 minutes.
  7. Repeat step 3 to verify the results of the publishing.
  8. Repeat step 4 to collect a new memory dump file.
  9. When contacting Sitecore Support, share the following details:
    • The ID, language, version of the item modified in step 5 and the change that was made; in other words, the old field value and the new field value.
    • The HTTP session archives (files created in steps 3 and 7).
    • The memory dumps (files collected in steps 4, 8, and possibly in step 6 ).
    • Sitecore log files covering the period of the test (both for CM and CD instances).
    • The contents of the EventQueue table of the publishing target database.
  10. Revert the configuration changes applied in steps 1 and 2.

Refer to KB0862874 for details on how to upload files to the file storage.