Chat now with support
Chat with Support

LiteSpeed for SQL Server 8.9.5 - Security and Compliance Guide

Configure Logging in LiteSpeed

Logging is available for the following areas in LiteSpeed:

  • Core Engine
  • Backup/Restore
  • Installation and Remote Deploy
  • Maintenance Plans
  • Log Shipping
  • Object Level Recovery
  • LiteSpeed UI Console Activity

NOTE: Log shipping plans activity is also logged and displayed in the History tab of the Log Shipping pane (CTRL+2). See the Configure Log Shipping guide for more information.

Installer Logging

Installer log files are created in the default output directory. When you use the Remote Deploy Configuration wizard to deploy LiteSpeed on SQL Server instances, this creates a 'RemoteDeploy'-prefixed log file on the machine where you run the remote deploy from and 'SLSInstall'-prefixed log files on all target servers. For more information, see Log File Naming and Location.

Backup/Restore Logging

Using the following instructions you can enable logging for a particular backup or restore activity. To log all backup/restore activity on the server, see Instance-Wide LiteSpeed Logging.

To enable backup/restore logging, do one of the following:

Instance-Wide LiteSpeed Logging

LiteSpeed's advanced tracing facility allows for even more granular control over the major LiteSpeed features at the server level.

To enable/disable advanced logging

  1. Right-click an instance in the server tree, select Support and then LiteSpeed Logging.

  2. Select one or more of the following options:

    • Core Engine—To log all backup/restore activity on the server, including log shipping and Fast Compression backups, but not Maintenance Plans backup tasks. For more information, see Reporting and Logging in Maintenance Plans. about logging options in Maintenance Plans.
    • Object Level Recovery (OLR)—To log read operations and object-level recovery.
    • Log Ship—To log backup/copy/restore Log Shipping jobs, but not transaction log backups and restores.
    • Fast Compression—To log Fast Compression jobs and Fast Compression backups.
    • Smart Cleanup Policies—To log Smart Cleanup Policies activity.
    • SLSMedia—To log SLSMedia activity.

    Clear one or more checkboxes to disable advanced logging for those options.

  3. Complete the dialog. Review the following for additional information:

    Option Description
    Log file path

    This parameter specifies a path to a default output directory into which the log files are written. For more information, see Log File Naming and Location.

    Flush output to log file after every write (slower) LiteSpeed will perform a disk flush after each record. Select this parameter if you experience program exceptions resulting in a process abort.
    Delete log file on success A log file is only saved if an error has occurred during execution.
    Log rollover size This will limit the size of the log file, so that only the last records that fit within the specified size will be kept. Use this option in the case of a long running application, when the log file becomes overly large, or when an error happens near the end of execution. Otherwise, set the rollover size value to zero.

NOTES:

  • Enabling Core Engine advanced logging will not override the logging level specified in wizards and procedures.
  • Be sure to disable advanced logging after it is no longer needed.

Trace Parameters

Parameter Description Type Default Value
DeleteLogs This parameter will cause the logfiles to be automatically deleted when they are closed unless the tracing facility has been notified that an error has occurred during execution. boolean 0
Flushing This parameter will direct the tracing facility to perform a disk flush after each record. As a performance enhancement. This parameter should be set in the case of program exceptions resulting in an abend (process abort).

boolean

0
MultiLogs This parameter will direct each traced thread to open an independent log. Each logfile's name will be augmented to include the respective thread id. This setting is not currently available for xpSLS.

boolean

0
Rollover

In the case of a long running application (or extended tracing within xpSLS), the logfile(s) can become overly large. When troubleshooting problems, the most interesting part is often an error that happens near the end of execution. This parameter will limit the size of the logfile: only the last records that fit within the specified size will be kept.

The numeric size specification may include one of the following suffixes: KB, MB, or GB. These will limit the logfile to the specified size in kilobytes, megabytes, or gigabytes respectively.

numeric

0
Indention Within the text of the log file, the information is indented to help visualize the nested function levels. The numeric value specifies the indention tab in characters. numeric 2
LogPath This parameter is a path to a directory into which the logfile will written. The value should not include a filename component. Logfile names will be chosen automatically by the tracing facility. string <current directory>
Columns

This parameter is a comma-delimited list of the information to include in the logfile. The records within trace logfiles are prefixed with information in a columnar format. The presence or absence of each of these columnar fields can be configured. The currently allowed values are:

  • Date— Date in the format: YYYY-MM-DD
  • Time—Time in the format: hh:mm:ss.sss
  • Func—Function name which is producing the trace record
  • Domain—Domain name for which this function is associated
  • PID—Process-id
  • TID—Thread-id
  • All—Include all available columns

Note: The thread-id is not included when using multilogs since the logfile name includes the thread-id. The specification of the columns also allows for the ability to add and subtract using a + or - prefix character. (The + is provided for completeness). So for example, if you want all of the columns except the date, use the following

Columns=All,-Date

string

If Multilogs=0, Time,Func,Domain,TID

If Multilogs=1, Time,Func,Domain

Domain

Trace logging within the applications is organized into the following domains:

 

You can supply multiple instances of this argument.

string

(none)
       

Examples

  • To log all backup/restore activity, enter the following:

    Domain=sls:All

  • To log all backup/restore activity and delete logs unless the tracing facility has been notified that an error has occurred during execution, enter the following:

    Domain=sls:All

    Flushing=1

    DeleteLogs=1

    This name format means that files will commonly be listed in chronological order and grouped by source.

    Log File Naming and Location

    By default, log files are written to C:\Documents and Settings\All Users\Application Data\Quest Software\LiteSpeed\SQL Server\Logs (or C:\ProgramData\Quest Software\LiteSpeed\SQL Server\Logs). This location is specified by the logpath value in the LiteSpeedSettings.ini file. (Usually, C:\Documents and Settings\All Users\Application Data\Quest Software\LiteSpeed\SQL Server\LiteSpeedSettings.ini.)

    To change the default output directory

    1. Right-click an instance in the server tree, select Support and then LiteSpeed Logging.

    2. Enter a new location in the Log file path field.

    Log files will have one of the following formats:

    • Source YYYY-MM-DD hh-mm-ss PPPP.Log
    • Source YYYY-MM-DD hh-mm-ss PPPP TTTT.Log
    • SLSInstaller - YYYYMMDD hh-mm-ss-xxx.txt

    Where source components are the following:

    • SLS (Backup or restore operations)
    • OLR
    • LogShip
    • FastComp
    • Extractor
    • SCleanup
    • xpSLS

    Other components of the log file name are as follows:

    • YYYY—4-digit year
    • MM—2-digit month
    • DD— 2-digit day of the month
    • hh— 2-digit hour using the local 24-hour clock
    • mm—2-digit minute
    • ss— 2-digit second
    • xxx—3-digit millisecond
    • PPPP—4-digit process id
    • TTTT— 4-digit thread id

    When you use the Remote Deploy Configuration wizard to deploy LiteSpeed on SQL Server instances, this creates a 'RemoteDeploy'-prefixed log file on the machine where you run the remote deploy from and 'SLSInstall'-prefixed log files on all target servers.

    LiteSpeed UI Console Activity Logging

    The LiteSpeed UI Console activity is logged in the Windows Application event log.

    To set the LiteSpeed UI Console logging level

    1. Select Application button | Options.
    2. On the General tab, select logging level.

     

    Related Topic

  • Related Documents

    The document was helpful.

    Select Rating

    I easily found the information I needed.

    Select Rating