Skip to main content

XTM Connect – Sitecore User Guide for Administrators

Viewing XTM Connect log entries

It is useful to view log entries for troubleshooting and to monitor system performance. We recommend that XTM Connect log entries are stored separately from Sitecore log entries, in your Sitecore instance. For details, see Separating XTM Connect log entries from Sitecore log entries.

The method for viewing log entries varies according to where they are located:

  • To view log entries in Sitecore when it is installed locally on Azure, contact your Azure System Administrators for more information on how to access logs. Access to logs differs according to the Azure configuration.

  • There are two ways to view log entries in Sitecore when it is installed on a local Windows Server:

    • Via the Reporting Tools. This quickly provides access to individual log files, but you cannot restrict the display to the last 10 Kb of a log file's contents.

    • Via the Administration tools. This enables you to select log files for display by type and restrict the display to the last 10 Kb of a log file's contents.

Viewing log entries via the Reporting Tools:

  1. Log in to Sitecore as an Administrator.

  2. In the main Sitecore Experience Management screen, select the Desktop icon. The Desktop screen is displayed.

  3. In the Desktop screen, select the Sitecore icon on the bottom left. A popup containing options and menus is displayed.

  4. Select the Reporting Tools menu,

  5. Select the Log Viewer option, The Log Viewer popup is displayed.

  6. To open a log file, select the Open button. The Open Log File popup, containing a list of recent log files, is displayed. You can see their size and the date on which they were last modified.

  7. Select the required log file from the list and then select the Open button.

    Result: The log file contents are displayed.

  8. You can now:

    • download the log file contents to a text file. To do so, select the Download button. The text file is downloaded to the Downloads area on your local computer. You can view or edit the file there.

    • delete the log file. To do so, select the Delete button. A Message popup prompts you to confirm that you want to delete the log file. If you select OK, the log file is deleted. If you select Cancel, the popup closes and the file is not deleted.

    • refresh the log file contents. To do so, select the Refresh button. The contents are refreshed immediately.

  9. To close the Log Viewer popup, select the Close icon (cross). The popup closes and the Desktop screen is displayed.

Viewing log entries via the Administration Tools:

  1. Log in to Sitecore as an Administrator.

  2. In the main Sitecore Experience Management screen, select the Control Panel icon.

  3. In the Control Panel screen, select the Administration tools option in the ADMINISTRATION section. You see the Administration screen.

  4. In the Diagnostics and Security section, on the left, select Logs. A list of log file types is displayed.

  5. Select the type of log file that you want to display. A list of stored log files is displayed.

  6. At the top, you see the name of the most recently modified log file. The file naming convention is usually "log.[date]", where [date] is the date on which the log file was created. The file name can contain other details, depending on the configuration in your system.

    Select one of the options below the log file to:

    • display the entire log file contents

    • display the last 10 Kb of the log file contents

    • download the file

  7. If other files are listed below the most recent one, you can download them. To do so, select a file's name. It is downloaded to the Downloads area on your local computer. You can view or edit the file there.

In this section: