Working with the WebSphere DataPower XC10 Appliance log files

The log files that are associated with WebSphere® DataPower® XC10 Appliance are stored on the appliance. The viewable logs can be viewed directly from the appliance with the user interface or they can be downloaded to your local file system for review.

Before you begin

You must be assigned the Appliance administration permission to perform these steps.

About this task

Log data is stored directly on the appliance. You can provide the trace.zip file to the IBM® Support team.

Procedure

  1. In the user interface, click ApplianceTroubleshooting and expand Logging. The log data is stored on the appliance. By expanding the Logging section, you have access to the available logs using the log viewer and can download the available logs to your file system for more review.
  2. View the current log files. Click one of the following links to display the logs:
    • View current error file
    • View current trace file
    • [Version 2.5 and later] View current health file
    A new web browser window is opened for the log viewer. The log viewer is used to view the trailing 10 lines of the log you selected. New log entries are appended into the log viewer as they occur. The log viewer has several actions that control the behavior of the log viewer.
    1. Click Pause to stop new log entries from being appended. This action is only available if the log viewer is accepting new entries.
    2. Click Restart for new entries to be appended. This action is only available if the log viewer is not accepting new entries.
    3. Click Clear to clear all the data from the log viewer. This action is available whether the log viewer is accepting new entries or if it is not accepting new entries.
  3. Click Download log files to save all the available logs to your file system. If you must view information about events that have occurred, then you must use this link. A window is presented so you can open the compressed file or save it to your file system. The trace.zip file contains all the log files to provide to the support team.

    A set of CSV files is included in the trace.zip file that you can use to track historical data for the servers on the appliance. Within the trace.zip file, the CSV files are in the server_name/logs directory. The files are named: jvmstats.log, mapstats.log, and ogstats.log. You can collect information from the CSV files such as memory usage by the map or server, map hit rates, transaction times, and throughput.

  4. In the Configure trace levels section, you can view or modify the trace levels. You can edit the trace levels for the Administrative Console or the Data Grid. For the administrative console, you can change the output of the default logger to one of the following trace levels:
    • OFF
    • SEVERE
    • WARNING
    • INFO
    • FINE
    1. Add a trace string. Click Add trace setting and enter in a valid trace string. The trace level for a new trace string is set to INFO by default.
    2. Remove a trace string Click the remove icon (Remove icon) next to a trace string to remove that trace string.
    3. Modify a trace level. Click the trace level value and select a new trace level. Click Save to commit the new trace level for the specified trace string.

What to do next

If the web console is not available, you can still retrieve the trace.zip file. Complete the following steps from the command line to retrieve the log files to provide to IBM Support:
  1. Collect the log files.
    Console> platform must-gather 
  2. List the generated log files.
    Console> file list 
  3. Copy the logs from the appliance.
    Console> file put <whateverNameIWant>.tgz scp://root@remoteMachine.myco.com:/myRemoteMachinePath/<whateverNameIWant>.tgz