Publishing Service: Enable “Debug” logging level

Subscribe to my newsletter and never miss my upcoming articles

The Publishing Service is a module that replaces Sitecore publishing functionality. This module increases the speed for publishing large volumes of items and improves the user experience.

As the Publishing Service runs on a separate process to the Sitecore CM instance, it contains its own logging file located at the (PublishingServiceInstallationFolder)/logs folder. By default, it only logs data on the “Information” logging level.

In this post, you will learn how to set the “Debug” logging level to get more information.

Before we start, be careful with enabling DEBUG. It is great for getting details, but it will overload your server with the heavy I/O streaming on the log files. Use it with caution.

As mentioned before, the Publishing Service only logs data on the “Information” logging level by default. You can find the default logging configuration in the (PublishingServiceInstallationFolder)/config/sitecore/sc.logging.xml file of the publishing service installation location. So how do we enable “Debug” logging level?

image.png

Override the default logging level

As instructed in the Publishing Service Installation and Configuration Guide the first step is to create a file named sc.logging.json in the (PublishingServiceInstallationFolder)/config/development/ folder and add the following:

{
    "Sitecore": {
        "Publishing": {
            "Logging": {
                "Filters": {
                    "Sitecore": "Debug"
                }
            }
        }
    }
}

Now, you have to start the Publishing Service in development mode to get additional logging information. Assuming that you are hosting Publishing Service in IIS, here is how you enable development mode. In the (PublishingServiceInstallationFolder)/web.config file add the following entry within aspNetCore the node.

image.png

Finally, restart the application pool of your Publishing Service host.

Once you make a first request to the Publishing Service, you should see more detailed log. You can also simply make a request to http://(PublishingServiceHostname)/api/publishing/operations/status.

image.png

That’s it for this post. I would like to recommend Publishing Service v2.0 – Quick Start Guide post by Stephen Pope‘s for those you want to get started on installing and configuring Publishing Service.

No Comments Yet