Troubleshooting using log files

You can enable logging for IBM Wazi Developer for Workspaces to produce detailed logs that can be used to troubleshoot problems. Logs can be valuable inputs when you file defects or contact technical support. If you want to open a support case, follow the instructions to collect the required system information.

Components and settings defined by devfiles

  1. Set the logging preference to DEBUG.

    1. In the main window, click the gear icon on the lower left, and select Settings or Open Preferences.

    2. In the search bar, type logger.

    3. Under Zopeneditor > Logger, select DEBUG from the dropdown list.

  2. Gather Information from the Output console window.

    1. From the top menu bar, select View > Output to open the Output console window.

    2. From the dropdown list, in the Output console window, select IBM Z Open Editor.

    3. Extract all the information from the Output console output displayed in a text file or as a screen capture.

    4. The output should include the following information at a minimum:

      • IBM Z Open Editor version

      • Editor platform and version

      • Editor Installation information

      • Java SDK configuration location and memory allocation

      • Key user settings

      • Zowe Explorer VS Code Extension version

      • Other VS Code Extensions visible

Locations of VS Code extension and other log files

1. Enabling logging

  1. Set the logging preference for IBM Z Open Editor.

    1. In the main window, click the gear icon on the lower left, and select Settings or Open Preferences.

    2. In the search bar, type logger.

    3. Under Zopeneditor > Logger, select DEBUG from the dropdown list.

  2. Set the logging preference for IBM Z Open Debug.

    1. In the main window, click the gear icon on the lower left, and select Settings or Open Preferences.

    2. In the search bar, type api log.

    3. Under the Zopendebug > Profile View > Api Log entry, check the box.

2. Locating the log files

  1. Locate the log files by using a terminal window for a specific container.

    1. From the top menu bar, select Terminal > Open Terminal in specific container.

    2. When prompted to select a container for the new terminal, select wazi-plugins<id>.

    3. You can now find VS Code extension and other logs in the following locations:

      Log Procedure to find the log location
      Z Open Editor log
      1. Open the Output console window for the IBM Z Open Editor.
      2. The location is specified in Output console window on the first line: This log file is available at /home/wazi/.theia/logs/.../zopeneditor...log
      User Build log
      1. Open the Output console window for the IBM User Build.
      2. The location is specified in Output console window on the first line: This log file is available at /home/wazi/.theia/logs/.../userbuild...log
      Zowe Explorer log Log files are in /tmp/vscode-unpacked/ibm.wazi-developer.latest.<id>.wazi-vscode-extension-for-zowe.vsix/extension/logs/zowe.log.
      RSE API Plug-in for Zowe CLI log Log files are in /home/wazi/.zowe/zowe/logs/zowe.log.
      Z Open Debug log Log files are in /projects/.debug/logs.

CodeReady Workspaces version information

  1. Obtain the version of CodeReady Workspaces extensions.

    1. Open your CodeReady Workspaces workspace.

    2. From the top menu bar, select Help > About.

    3. Extract all the information from the List of extensions in a text file.

  2. Obtain the version of OpenShift Container Platform (OCP).

    1. From the top menu bar, select Terminal > Open Terminal in specific container.

    2. When prompted to select a container for the new terminal, select vscode-yaml<id>.

    3. In terminal window, enter the command oc version .

  3. Obtain the version of IBM Wazi Developer for Workspaces.

    1. From the top menu bar, select Terminal > Open Terminal in specific container.

    2. When prompted to select a container for the new terminal, select wazi-plugins<id>.

    3. In the terminal window, enter the command echo env | awk -v val=$VERSION '{print val}'.