Enable Management Center client-side logging and tracing

+

Search Tips   |   Advanced Search

A Site Administrator can enable logging and tracing for the Management Center.

Log and trace information is stored in a log file on the WebSphere Commerce Server. If you plan to do this, then first configure logging in the WAS Administrator's Console, specifying the Management Center trace component...

com.ibm.commerce.lobtools

By default the OpenLaszlo debugger window is enabled. To disable the OpenLaszlo debugger window that displays when using the Management Center user interface...

  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.

To enable client-side logging and tracing:

  1. Go to...

    https://host_name:8000/lobtools?logger.display=true

  2. Log onto the Management Center:

    Option Description
    User Name Type your WebSphere Commerce user name.
    Password Type your WebSphere Commerce logon password for this user name.

  3. Click Log On.

  4. Within the Management Center, from the Management Center menu, select Logging and Tracing.

  5. From the Logging and Tracing dialog, expand Log Level Options and provide the following information:

    Option Description
    Default Log Level 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 WAS information center.

    Component Log Levels For each WebSphere Commerce 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 Default Log Level.

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

  6. From the Logging and Tracing dialog, expand Log Target Options and provide the following information:

    Option Description
    Send to LASZLO DEBUGGER Window Select this option to record logging and tracing information to the OpenLaszlo debugger window that displays when using the Management Center user interface. The debugger window only displays if, within WebSphere Commerce Developer, you have compiled Management Center files with the debugger option set to true.

    Alternatively, you can select to view logging and tracing information from a log file on the WebSphere Commerce Server. See Send to Server.

    Depending on the send frequency you specify within this dialog, the information is sent to the server at the specified intervals.

    Send to Server Select this option to record logging and tracing information to a log file on the WebSphere Commerce Server located in this directory:

    Alternatively, you can select to view logging and tracing information from an OpenLaszlo debugger window while using the Management Center user interface. See Send to LASZLO DEBUGGER Window.

    Depending on the send frequency you specify within this dialog, the information is sent to the server at specified intervals. See Send Frequency.

    Send Immediately Select this option to immediately display logging and tracing information to the OpenLaszlo debugger window that displays when using the Management Center user interface. The debugger window only displays if, within WebSphere Commerce Developer, you have compiled Management Center files with the debugger option set to true.

    This option allows you to always send information to the debugger window immediately, without waiting for the scheduled interval specified in this dialog. This option is only enabled when you have also selected Send to LASZLO DEBUGGER Window.

    Message Buffer Size 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.
    Send Frequency Select 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 WebSphere Commerce Server, or to the OpenLaszlo 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 Enable to start recording logging and tracing information, using the settings specified in the Logging and Tracing dialog. When you want to stop recording the information, click Disable.

  8. Optional: Click Send Now to log and trace information immediately, without waiting for the next scheduled send interval. For example, you may want to monitor an activity at a specific moment, such as immediately after a user saves an object using the Management Center.

    Depending on your send location specified in the Logging and Tracing dialog, the information is sent to the WebSphere Commerce Server, or to the OpenLaszlo debugger window.

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 theManagement Center, the Logging and Tracing option displays in the Management Center 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 OpenLaszlo 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.
logger.target Specify where to send the logging and tracing information. Available options are:

  • logger.target=server to record logging and tracing information to a log file on the WebSphere Commerce Server located in this directory:

  • logger.target=debugger to record logging and tracing information to the OpenLaszlo debugger window that displays when using the Management Center user interface. Note that the debugger window only displays if, within WebSphere Commerce Developer, you have compiled Management Center files with the debugger option set to true.

logger.sendImmediately Specify logger.sendImmediately=true to always record logging and tracing information to the OpenLaszlo debugger window that displays when using the Management Center user interface. Note that the debugger window only displays if, within WebSphere Commerce Developer, you have compiled Management Center files with the debugger option set to true.

This option allows you to always send information to the debugger window immediately, without waiting for the scheduled interval specified in the logger.flushInterval parameter.

logger.components Specify logger.components=component_name to log and trace new components. These new components will be displayed in the Component Log Levels list, in addition to the default WebSphere Commerce 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.target=debugger&logger.sendImmediately=true&logger.components=com.company.component1,com.company.component2