Troubleshooting using log files
You can enable logging for IBM Wazi for Dev Spaces 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
Set the logging preference to
DEBUG
.In the main window, click the gear icon on the lower left, and select
Settings
orOpen Preferences
.In the search bar, type
logger
.Under
Zopeneditor
>Logger
, selectDEBUG
from the dropdown list.
Gather Information from the Output console window.
From the top menu bar, select
View
>Output
to open the Output console window.From the dropdown list, in the Output console window, select
IBM Z Open Editor
.Extract all the information from the Output console output displayed in a text file or as a screen capture.
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
Set the logging preference for IBM Z Open Editor.
In the main window, click the gear icon on the lower left, and select
Settings
orOpen Preferences
.In the search bar, type
logger
.Under
Zopeneditor
>Logger
, selectDEBUG
from the dropdown list.
Set the logging preference for IBM Z Open Debug.
In the main window, click the gear icon on the lower left, and select
Settings
orOpen Preferences
.In the search bar, type
api log
.Under the
Zopendebug
>Profile View
>Api Log
entry, check the box.
2. Locating the log files
Locate the log files by using a terminal window for a specific container.
From the top menu bar, select
Terminal
>Open Terminal in specific container
.When prompted to select a container for the new terminal, select
wazi-plugins<id>
.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 - Open the Output console window for the
IBM Z Open Editor
. - 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 - Open the Output console window for the
IBM User Build
. - 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
.- Open the Output console window for the
CodeReady Workspaces version information
Obtain the version of CodeReady Workspaces extensions.
Open your CodeReady Workspaces workspace.
From the top menu bar, select
Help
>About
.Extract all the information from the
List of extensions
in a text file.
Obtain the version of IBM Wazi for Dev Spaces.
From the top menu bar, select
Terminal
>Open Terminal in specific container
.When prompted to select a container for the new terminal, select
wazi-plugins<id>
.In the terminal window, enter the command
echo env | awk -v val=$VERSION '{print val}'
.
How to send data to IBM support
You can create a .zip file of all the information gathered above and the follow the IBM Support instructions about sending data to send it to IBM Support.