Enabling client-side logging and tracing

A Site Administrator can enable logging and tracing for the to troubleshoot problems that a business user might have while using the . Client-side logging and tracing refers to tracking all the actions that a business user completes while using the user interface.

Before you begin

Review the following information before enabling tracing:
  • Log and trace information is stored in a log file on the Server. If you plan to do this, then you must first configure logging in the WebSphere Application Server Administrator's Console, specifying the (com.ibm.commerce.lobtools) trace component.
  • By default the debugger window is enabled. To disable the debugger window that displays when using the user interface, complete the following steps:
    1. Open WebSphere Commerce Developer and switch to the Package Explorer view.
    2. Right-click LOBTools and click Properties. Select OpenLaszlo Settings.
    3. Clear the Enable the debug console check box. Click Apply.

Procedure

  1. Access the following Web address in your browser: https://host_name:8000/lobtools?logger.display=true
  2. Log onto the :
    OptionDescription
      Type your user name.
      Type your logon password for this user name.
  3. Click .
  4. Within the , from the menu, select .
  5. From the dialog, expand and provide the following information:
    OptionDescription
      Select the type of information and level of detail you want to log and trace:
    • OFF
    • SEVERE
    • WARNING
    • INFO
    • CONFIG
    • FINE
    • FINER
    • FINEST
    • ALL

    The default log level is INFO to track informational details only.

    For detailed definitions about the log levels, refer to the WebSphere Application Server information center.

      For each component listed, select the type of information and level of detail you want to log and trace. Here are the default components you can track:
    • com.ibm.commerce.lobtools.foundation.view
    • com.ibm.commerce.lobtools.foundation.model
    • com.ibm.commerce.lobtools.foundation.service
    • com.ibm.commerce.lobtools.foundation.util
    • com.ibm.commerce.lobtools.foundation.shell

    The supported log levels are the same as the ones defined for .

    The default log level for each component is INFO, to track informational details only.

  6. From the dialog, expand and provide the following information:
    OptionDescription
      Select the logging and tracing buffer size, defined by the number of messages that the buffer can retain. The minimum buffer size is 100 messages and the maximum is 5000 messages. The default is 1000 messages.
    WebSphere Commerce Developer WebSphere Commerce DeveloperSelect the frequency, in seconds, that logging and tracing information should be recorded. The location of the information depends on whether you specified to send the information to the Server, or to the debugger window. The minimum send frequency is every 10 seconds and the maximum is every 600 seconds. The default is every 20 seconds.
  7. Click to start recording logging and tracing information, using the settings specified in the dialog.
    When you want to stop recording the information, click .
  8. Optional: Click to log and trace information immediately, without waiting for the next scheduled send interval. For example, you might want to monitor an activity at a specific moment, such as immediately after a user saves an object using the .
    The logging and tracing information is sent to a log file on the WebSphere Commerce Server located in this directory:
    • LinuxWindowsAIXWC_profiledir/logs/server1
    • WebSphere Commerce DeveloperWCDE_installdirwasprofile/logs/server1
    Depending on the send frequency you specify within this dialog, the information is sent to the server at specified intervals.

Example

Alternatively, you can also enable logging and tracing using URL parameters by accessing the following Web address in your browser: https://host_name:8000/lobtools?logger.display=true, and appending the following parameter names and valid values:

Parameter Name Description
logger.display If logger.display=true, upon logging into the, the Logging and Tracing option displays in the menu. Select Logging and Tracing to open the Logging and Tracing dialog.
logger.enabled Specify logger.enabled=true to enable logging and tracing.
logger.level Specify the type of information and level of detail you want to log and trace. Available options are:
  • logger.level=OFF
  • logger.level=SEVERE
  • logger.level=WARNING
  • logger.level=INFO
  • logger.level=CONFIG
  • logger.level=FINE
  • logger.level=FINER
  • logger.level=FINEST
  • logger.level=ALL
logger.bufferSize Specify the logging and tracing buffer size, defined by the number of messages that the buffer can retrain. The minimum buffer size is 100 messages and the maximum is 5000 messages. For example, specify logger.bufferSize=1000 to display 1000 messages in the buffer.
logger.flushInterval Specify the frequency, in seconds, that logging and tracing messages in the message buffer should be sent to the target (that is, to the server or the debugger window). The location of the messages depends on the value you specify for the logger.target parameter. The minimum send frequency is every 10 seconds and the maximum is every 600 seconds. For example, specify logger.flushInterval=100 to record information every 100 seconds.
WebSphere Commerce Developer logger.components Specify logger.components=component_name to log and trace new components. These new components will be displayed in the list, in addition to the default components list.

Use a comma (,) to separate component names, if you have multiple components. For exxample, logger.components=com.company.component1,com.company.component2,com.company.component3.

All parameters are optional. Separate each parameter name and value pair with an ampersand (&). Here is an example of enabling logging and tracing using the URL and parameters method: https://host_name:8000/lobtools?logger.display=true&logger.enabled=true&logger.bufferSize=500&logger.Interval=30&logger.level=ALL&logger.components=com.company.component1,com.company.component2