Troubleshooting: Log FilesCreated: 2019-11-20 10:50:39
Modified: 2020-05-22 15:55:47
Tags: Troubleshooting UnitySync
UnitySync creates a log file for each synchronization run. Discovery, Simulation, and Synchronization phases generate their own log files. The files contain fives levels of error logging, 1 through 5, with 1 the lowest and 5 the highest.
Most situations only call for the default error logging level of 2. The log files are in .txt format and are viewable in UnitySync or in a text editor like Notepad. Larger log files (generated at Log File level 3-Detailed or higher) may need to be viewed in a text viewer equipped for larger files.
Log files are located in …\UnitySync\Connections\YourConnectionName\Logs.
To view the log files, you may open them from this location or select the file from the drop-down in the Logs section of the General tab, then click the Download Log button. UnitySync names the log files based on date and time and are not automatically deleted. Delete them manually or by configuring --cleanlogs as described in Log File Management.
If low level logging is chosen (2-Lowest), the first synchronization run will be the largest and will contain several lines of information for each object that is synchronized. Later synchronization runs will only log changes (deltas). We recommend that you set your logging level to 2-Lowest as a default.
Higher level logging (3-Detailed, 4-Verbose, 5-Debug) generates a more detailed log. These detailed logs may be very large, so only enable high level logging to troubleshoot issues. For most issues, a log generated at 3-Detailed is sufficient for troubleshooting.
If you configure the global E-mail Notifications option in UnitySync, it will send a summary email for each successful synchronization run, or an email when an error occurs. Chose whether or not you want the log file attached to these messages.
Interpreting Log Files
Looking at a discovery or sync log file, you’ll see that the top part of the file has several sections. These sections are the steps UnitySync takes to prepare for a synchronization run.
- The configuration parameters that were defined through the Admin program are loaded.
- The map, structure, and exclusions files are loaded.
- The Source and Destination directories are discovered and accessed.
- The software license is detected before any input/output takes place.
The Discovery log shows the search of each Source container, all excludes and all objects successfully exported. The Run Summary will show the total number of objects processed and if there were any errors. The Sync log shows additions, modifications and deletions (deltas) made to containers and user objects. The Run Summary shows the total number of additions, modifications, deletions (deltas) and entries processed. It will also show any errors, if there were any.
Take a look at the logs to make sure that you have the number or entries processed that you expected to have. Remember, after the initial sync is done, only changes that have made Source entries different from Destinations entries will be processed.
UnitySync log files are important to troubleshooting most synchronization errors. Email the connection’s log file(s) to Technical Support when you ask for help from tech support.
Find the log files in: …\UnitySync\Connections\YourConnectionName\Logs
There are up to three log files (discovery, sim, sync) for each synchronization run. All logs for your specific connection should be sent to support unless otherwise requested. Zip the log files, or upload large zipped log files to our secure upload site.
Deleting Log Files Manually
- Go to …\UnitySync\Connections\YourConnectionName\Logs
- Select the logs you wish to delete, and right click or use your Delete key on your keyboard.