Sitecore Log Analyzer (SCLA)

  0 rating
4/16/2013 5:41:32 AM
4/17/2015 1:39:21 PM
Provider: Sitecore

About

Sitecore Log Analyzer is a powerful tool for parsing Sitecore log files. It provides the interface to explore and navigate through large amount of log data. For instance, you can group and analyze all errors, warnings, debug and audit messages logged by Sitecore application, monitor performance counters, and get a visual overview of website uptime and downtime intervals. The tool is designed for Sitecore administrators and developers who troubleshoot or monitor the health of Sitecore applications.

Features

  • Analyzing, grouping and navigating through log entries of Sitecore instance.
  • Analyzing log entries of Sitecore instances in Azure.
  • Analyzing Sitecore instance performance using Health Monitor counters.
  • Investigating Sitecore instance lifetime using visual timeline.
  • Reporting log entries to Sitecore. (this is a a background task which is performed in case you agreed to send this information to Sitecore)


Documentation

Documentation
  • Documentation > User Guide
    Sitecore Log Analyzer User Guide

    Location and Filtering.


    To parse log files with the Sitecore Log Analyzer application, select log files in the Log location field, specify (optionally) some filters (String filterDate filter) and click the Analyze/refresh* button.
    Note, that each log file must contain the “log.<created date>” substring in its name to be successfully parsed.

    • String filter. You can filter information by string. Only the log entries containing this string will be parsed and shown in the application. Other log messages will be ignored.
    • Date filter. You can filter information by time period. Only the log entries covered by specified interval will be parsed and shown in the application. Arrow buttons allow setting the minimal and the maximal available date/time values.

     


    The Sitecore Log Analyzer supports Drag&Drop. Drag and drop log files or a folder into the application to start analyze them.


    You also can run AddSCLAItemToContextMenu.bat file to enable possibility analyze log files using context menu in Windows.

    (see 'To add menu item into Windows context menu' section of Installation Guide)


    Open with Sitecore Log Analyzer option will be added to context menu of folders and txt files.





    Timeline control.


    The Timeline control is located at the bottom of the application and shows the position of log entries on the lifetime of Sitecore instance. It allows you to select a time range and to zoom in. To zoom in, select the time range, right-click it and select the Zoom In option in the context menu. The time range that you selected is marked in blue. The Zoom In option limits the time range of the log messages displayed in the application.
    The blue pointer shows the current time position in the logs. When you select a message, the pointer shows its time position in the log.

     

     

    You also can click on the point in timeline you are interested in to navigate to the corresponded log entry.


    Messages tab.

     

    The Messages tab provides an interface to look through each log message individually or together with others. On this tab, you can show or hide entries of the corresponding logging levels using checkboxes. The list of messages shows logs grouped by caption – for example, Cache created,Job started – and by exception type. 
    To group messages by stack trace, use the Group By StackTrace checkbox below the messages list. 
    Each message in the list has a checkbox to show/hide message in the Multiple Messages sub-tab.
    Use the Select All and Deselect All buttons to select and deselect all messages in the list.
    In the Multiple Messages area, double-click a message to open the dialog box that contains the full text of the log entry. Right-click the message to open the context menu that allows you to navigate to the log location in Raw View or copy the message to the clipboard. 
    The Single Message sub-tab shows the current message selected/highlighted in the list on the left.

     

     



    Health Monitor tab.


    The Health Monitor tab shows log messages of the Sitecore Health Monitor grouped by the names of performance counters.
    Click a performance counter to see the values logged by Health Monitor with date/time stamps. Select the corresponding checkbox to add a counter to the table.
    The Timeline control on this tab shows a graphic chart of the values for the selected performance counter. The counter shown on the Timeline is highlighted in yellow in the table.




    Audit tab.

     

    The Audit tab shows only Audit log messages. It provides an interface similar to the one on the Messages tab. The list on the right-hand side allows you to select users; and the list on the left-hand side allows you to select actions. This tab also contains the Timeline control that shows when the selected audits took place.

     



    Raw view tab.

     

    On the Raw View tab, you can browse the selected log files in raw mode. In raw mode, all the individual log files are merged to a single log. The Timeline control is colored according to the type of the most severe messages in the log during the colored time period.

    Raw View is also colored by default. You can disable it using context menu.




    Internal Program Log tab.


    The Internal Program Log tab shows the internal log of the Sitecore Log Analyzer.

    Additional features.


    Besides the functionality listed above, the Sitecore Log Analyzer provides the following features:


    • Exporting. You can export messages to the clipboard, in CSV format, as a TXT files. These options are available in the context menu throughout the tool.



    • Analysis reporting. Upon the user approval, the tool can send anonymous analysis summary to the Sitecore support server.  This report includes information about exceptions occurring in log files and some general information: number of log entries, Sitecore version, and so on. This information can help improve Sitecore products.
      To configure this functionality, change the value of the SendReportsToSCLAServer setting in SitecoreLogAnalyzer.config.

    Shortcuts.

    Whole application context:

    Ctrl+O - open new logs.
    Ctrl+R - reanalyze current logs (if Date filter is disabled new entries/files will be also analyzed in case logs were updated).
    Ctrl+A - Select/Deselect all log entries in a tab.

    Messages tab context:

    Ctrl+E - switch Erros checkbox.
    Ctrl+W - switch Warnings checkbox.
    Ctrl+I - switch Infos checkbox.
    Ctrl+F - switch Fatals checkbox.
    Ctrl+D - switch Debugs checkbox.
    Ctrl+G - switch Group By StackTrace checkbox.

    Raw View tab context:

    Ctrl+F - open search window.
    F3 - perform search using settings specified in a search window recently.
    0
  • Documentation > Installation Guide
    Sitecore Log Analyzer Installation Guide

    Prerequisites

     

    • Windows XP or later
    • .NET Framework 4.0
    • Logs of Sitecore CMS 6 or later

     

     

    To install Sitecore Log Analyzer tool:

     

    1. Download ZIP archive that contains the tool.
    2. Extract the downloaded archive to a new folder.
    3. Run SCLA.Launcher.exe file.
     
    To add menu item into Windows context menu:

    1. Go into 
    SCLA X.X.X  rev. XXXXXX folder in the application folder.
    2. Run AddSCLAItemToContextMenu.bat file.

    To remove menu item from Windows context menu:

    1. Go into 
    SCLA X.X.X  rev. XXXXXX folder in the application folder.
    2. Run DeleteSCLAItemFromContextMenu.bat file.

    Notes:

    If you want to make any changes in a tool config, go to 
    SCLA X.X.X  rev. XXXXXX in the application folder and find there SitecoreLogAnalyzer.config file.
    1
  • Documentation > Sitecore Log Analyzer with Azure
    Sitecore Log Analyzer with Azure (New)

    Overview

     

    Starting from version 2.0.0 rev. 140623 Sitecore Log Analyzer can analyze log files of Sitecore Azure instances. Please see further sections for the details.

     

    Enabling Sitecore Log Analyzer Azure module

     

    For being able to analyze the log files from the Sitecore Azure instance you need to enable Sitecore Log Analyzer Azure module that is disabled by default.

    For this you need to uncomment the following lines in the SitecoreLogAnalyzer.config file:

     

    <modules>
    <add name="Azure Storage Table" assembly="SitecoreLogAnalyzer.Modules.Azure">
    <invoker type="Sitecore.LogAnalyzer.Modules.Azure..." image="..."></invoker>
    </add>

    </modules>

     

    Analyzing logs from Azure

     

    After enabling Sitecore Log Analyzer Azure module you will be able to choose between two log sources when trying to select logs location. These log sources are File System and Azure Storage Table.

     

    Choose Azure Storage Table source:

     

     

     

    Azure Source Configuration dialog will appear. Here you need to specify the details of your Azure Storage account as well as some filtering data:

     

    For more information about the Azure Source connection and filtering settings please see the next section.

     

    After entering the necessary data and pressing OK you will see the main window of Sitecore Log Analyzer tool.

     

    Press Analyze / Refresh* button to start downloading and analyzing of the log data.

     

    Azure Source connection and filtering settings

     

    Storage Name (mandatory) – a name of the Azure Storage account where the logs reside.

    You can find it either through the Content Editor in the Azure storage item (Service Name field) under the corresponded farm item or in the Windows Azure Management Console.

     

    Windows Azure Management Console:

     

    1. Login to the console of your Azure Account through the following page:
    https://manage.windowsazure.com

    2. Access the All Items tab and find the Storage Account you want to get logs from:

     

     

    3. Use its name as the value for the Storage Name setting.

     

    Content Editor:

     

    1. Open the item /sitecore/system/Moudles/Azure item in Content Editor.

    2. Locate the the corresponded environment item.

    3. Under the environment item locate the farm item that contains the instances which logs you want to analyze.

    4. Select the desired storage item for the selected farm

    5. Use the value of the Service Name field as the value for the Storage Name setting.

     

     

    Storage Key (mandatory) – a key for connecting to the storage.

    You can find it in almost the same way as the value for the Storage Name setting.

     

    Windows Azure Management Console:

     

    1. Locate your desired Storage Account as described in the section for Storage Name setting.

    2. Select this Storage Account and press Manage Access Keys button at the bottom of the page.

     

     

    3. Manage Access Keys dialog will appear. Use the value of the Primary Access Key field as the value for the Storage Key setting.

     

     

    Content Editor:

     

    1. Locate the desired storage item as described in the section for the Storage Name setting.

    2. Use the Primary Access Key field as the value for the Storage Key setting.

     

     

    Filter by Role name (optional) – a coma-separated list of the web roles you want to analyze logs for (if empty, the logs for all available roles will be downloaded)

     

    Filter by Role Instance name (optional) – a coma-separated list of the web role instances you want to analyze logs for (if empty, the logs for all available role instances will be downloaded)

     

    Filter Query (optional) – a filter query that is used for filtering out the logs to load.

    See the following page for the information about its format:

    http://msdn.microsoft.com/en-us/library/ff683669.aspx

     

    Filtering can be performed by any column of the WADLogsTable table of the Storage Account.

     

    Example of the valid filter:

    DepliymentId eq '1f63e8a1908f45968110a16d051c0a6d' and Level le '3'

     

    Date Filter (UTC) – the UTC date and time filter that is used for filtering out the log to load.

     

    Additional notes about Sitecore Log Analyzer Azure module

     

    • Sitecore Log Analyzer Azure module do not analyze entries of WADLogsTable other than the ones recorded by Sitecore.

     

    • There is the SitecoreLogAnalyzer.Module.Azure.config file where you can set the default values for the Azure source configuragion settings. Their format should be the same as the one described above.

     

    • Sitecore Log Analyzer will not download the logs again if you press Analyze / Refresh button unless you changed a connection configuration

    2
Back
Release notes
Sitecore Log Analyzer 2.0.0 rev. 140603 is released.
Read more Back
Code examples

Solution screenshots(0)

Upload

Reviews (0)

Sort by: Date Most votes
  • Profile Avatar
    [fullName]

    Level: 0

    x0 x0 x0

    [date]

    [title]

    [text]

    Was this helpful?

    0

Comments (0)

Sort by: Date  Most votes

Leave a Comment

Comment must be field in
Post comment
loader

Write a review

Title can't be empty
Review can't be empty
Post review

Download

Title Description Download Action

Add File