Skip to main content
Version: v8.x - Umbraco 8

Debugging uSync

There may come a time when uSync isn't doing what you expect it to do ☹. This is a sad time for us all, we want to stop that from happening, but first we need to work out what is wrong.

The best way to do that is to turn on debug logging and work through what uSync is doing.

Turning on Debug Logging

Logging in Umbraco 8 is managed via Serilog which outputs all logging messages to files in the App_Data/Logs folder.

To turn on debug logging, add the following to the config/serilog.config file.

<add key="serilog:minimum-level:override:uSync" value="Debug" />

You will need to restart your site once you have edited this file.

Viewing the Logs

These logs can be viewed either inside Umbraco, in the settings section under Log Viewer, or externally using the Compact Log Format Viewer.

In both cases the query below will give you all the uSync messages in the log file:

StartsWith(SourceContext, 'uSync')

Verbose logging

If you are having issues with connections in uSync.Complete, you may need to turn on verbose logging.

As with debug logging, add a verbose logging line to the config/serilog.config file.

<add key="serilog:minimum-level:override:uSync" value="Verbose" />

By default, verbose log entries are not written to the logs, so you will also need to change the default logging level in the file.

You must update the following line of the serilog.config file.

<add key="serilog:write-to:File.restrictedToMinimumLevel" value="Verbose" />

Happy logging.