09. Synctool Logging

Introduction

This section describes how to customize event logging, view recent logs and events or set up automated log digests by email. These functions are grouped under the Logging tab in the Synctool user interface.

Email Reporting

At Email Reporting set up an automated email report, so that you receive updates in your mailbox from Synctool synchronizations. Zivver recommends setting up email reporting as this notifies the administrator of any synchronisation errors without having to log in to the Synctool server to look for errors in the synchronisation logs.

You decide by checking the corresponding boxes if you only want to receive email reports in case of errors or every time the Synctool was run scheduled and unattended.

By default no email report is sent, therefore the first step is to check the box at Send sync results by email.

  • SMTP Relay Host
    This is the Host Name of the SMTP Relay Host, for example smtp.example.org or smtp.office365.com or the IP Address of the relay host. This is a mandatory field.

  • Port
    This port will be used for SMTP traffic. Fill in 587 (recommended) or use port 25. This is a mandatory field.

  • Use TLS
    Check the box at if you want to use TLS.

  • User Name
    If you need to authenticate towards the SMTP Relay Host, then fill in the username for authentication. This may not be necessary.

  • Password
    If you need to authenticate towards the SMTP Relay Host, then fill in the password associated with the username for authentication. This may not be necessary.

  • From Address
    Enter an email address that will be the sender of the email reports. This can be a fictional address, such as synctool@your-organization-domain.com. This is a mandatory field. Recipients will receive the email reports from this (fictional) address.

  • Recipients
    Enter the email address that should receive the report. This can be a personal or shared mailbox. If you want to add multiple addresses, separate them by a semi-colon ; or add each new address on a new line. This is a mandatory field.

  • SEND TEST MAIL
    Send a test mail to test if you can send a message from the Synctool server to the recipients.

    If the test email fails
    If the test email failed, please consult your Exchange administrator or documentation on your mail server on how to relay smtp messages.
  • Mail only in case of errors
    Check this box if you only want to be emailed when an error occurs during synchronization. Zivver recommends enabling this feature.

  • Mail only when in Silent Mode (recommended)
    Check this box if you want to be emailed when the Synctool was run scheduled and unattended. For example by the Windows Task Scheduler.

Event Logging

At Event Logging you enable the options to write events to a file, Windows Events Log and create an Event summary.

Write events to a file

Enable Write events to file and specify a folder by clicking BROWSE. The log file will contain a status of how an account is processed during that synchronization.

Write event files in the Synctool folder
Best practice is to store the event files where you have stored the Synctool. For example, if you have stored the Synctool at C:\Program Files\Zivver.Synctool, then create a folder called Logs and Events. So that you can save the event logs in C:\Program Files\Zivver.Synctool\Logs and Events.

If you enable Write events to file but do not specify a folder, then event files will be written to the folder that contains the Synctool profile.

If you do not enable Write events to file, then no event file will be saved after running a synchronization.

Write events summary to a file

Enable Write events summary to file and specify a folder by clicking BROWSE. The summary only contains the amount of mutations done, how many were successful and how many failed.

Write event summary files in the Synctool folder
Best practice is to store the summaries of events where you have stored the event logs. For example, if you have stored the logs at C:\Program Files\Zivver.Synctool\Logs, then create a folder called Summary. This is so you can save the summary event logs in C:\Program Files\Zivver.Synctool\Logs\Summary.

If you enable Write events summary to file but do not specify a folder, then event files will be written to the folder that contains the Synctool profile.

If you do not enable Write events summary to file, then no event file will be saved after running a synchronization.

Write events to Windows Event Log

Enable Write events to the Windows Events Log if you already monitor Windows Events in a third party application (e.g. Splunk) and want to monitor Synctool events in your third party application.

Recent Logs

At Recent Logs you can find in-depth logs about background Synctool processes. If you run into any synchronization issues, you can find the corresponding logs in this tab. The logs are sorted on six different levels:

  • Trace
  • Debug
  • Warning
  • Error
  • Fatal

Recent Events

At Recent Events you can see background Synctool processes for the last action executed, such as manual synchronizations, preview changes or preview sources.

The items shown in the Recent Events contain information about loading, parsing and sanitizing source data. The Recent Events can help you identify where in a process something could have gone wrong.

Was this article helpful?

thumb_up thumb_down