Chapter 6. Troubleshooting CodeReady Workspaces

Procedure

1. Set the showLog attribute to true in the debug configuration.

   {
     "version": "0.2.0",
     "configurations": [
        {
           "type": "go",
           "showLog": true
          ....
        }
     ]
   }

2. To enable debugging output for a component, add the package to the comma-separated list value of the logOutput attribute:

   {
     "version": "0.2.0",
     "configurations": [
        {
           "type": "go",
           "showLog": true,
           "logOutput": "debugger,rpc,gdbwire,lldbout,debuglineerr"
          ....
        }
     ]
   }

3. The debug console prints the additional information in the debug console.

   

Procedure

1. Navigate to the Output view.

2. Select Go in the drop-down list.

   

Procedure

1. To enable the tracing of messages sent to the Typescript (TS) server, in the Preferences view, set the typescript.tsserver.trace attribute to verbose. Use this to diagnose the TS server issues.
2. To enable logging of the TS server to a file, set the typescript.tsserver.log attribute to verbose. Use this log to diagnose the TS server issues. The log contains the file paths.

Procedure

1. To get the path to the log file, see the Typescript Output console:

   

2. To open log file, use the Open TS Server log command.

   

Procedure

1. Navigate to the Output view

2. Select TypeScript in the drop-down list.

   

1. Open a terminal in the container that is running the Eclipse JDT Language Server plug-in (an example name for the container: vscode-javaxxx).

2. Inside the terminal, run the ps aux | grep jdt command to check if the Eclipse JDT Language Server process is running in the container. If the process is running, the output is:

   usr/lib/jvm/default-jvm/bin/java --add-modules=ALL-SYSTEM --add-opens java.base/java.util

   This message also shows the VSCode Java extension used. If it is not running, the language server has not been started inside the container.

3. Check all logs described in Checking important logs

1. Open a Java file and use the hover or autocomplete functionality. In case of an erroneous file, the user sees Java in the Outline view or in the Problems view.

1. To open this log file, open a terminal in the container that is running the Eclipse JDT Language Server plug-in. You can also view the log file by running the Java: Open Java Language Server log file command.
2. Run cat <PATH_TO_LOG_FILE> where PATH_TO_LOG_FILE is /home/theia/.theia/workspace-storage/<workspace_name>/redhat.java/jdt_ws/.metadata/.log.

1. Click File → Settings.
2. Open the Preferences view.
3. Expand the Intelephense section and set the trace.server.verbose preference value to verbose to see all the communication events (the default value is off).

Procedure

1. Click View → Output
2. Select Intelephense in the drop-down list for the Output view.

Procedure

1. Open a terminal in the container named vscode-xml-<xxx>.

2. Run ps aux | grep java to verify that the XML language server has started. If the process is running, the output is:

   java ***/org.eclipse.ls4xml-uber.jar`

   If is not, see the Checking important logs chapter.

Procedure

1. Check if the features are enabled. The XML plug-in provides multiple settings that can enable and disable features:

   • xml.format.enabled: Enable the formatter
   • xml.validation.enabled: Enable the validation
   • xml.documentSymbols.enabled: Enable the document symbols
2. To diagnose whether the XML language server is working, create a simple XML element, such as <hello></hello>, and confirm that it appears in the Outline panel on the right.
3. If the document symbols do not show, ensure that the xml.documentSymbols.enabled attribute is set to true. If it is true, and there are no symbols, the language server may not be hooked to the editor. If there are document symbols, then the language server is connected to the editor.
4. Ensure that the features that the user needs, are set to true in the settings (they are set to true by default). If any of the features are not working, or not working as expected, file an issue against the Language Server.

1. In the editor, open a terminal in the container that is running the YAML plug-in (an example name of the container: vscode-yaml-<xxx>).
2. In the terminal, run the ps aux | grep node command. This command searches all the node processes running in the current container.

3. Verify that a command node **/server.js is running.

   

1. Check if the features are enabled. The YAML plug-in provides multiple settings that can enable and disable features, such as:

   • yaml.format.enable: Enables the formatter
   • yaml.validate: Enables validation
   • yaml.hover: Enables the hover function
   • yaml.completion: Enables the completion function
2. To check if the plug-in is working, type the simplest YAML, such as hello: world, and then open the Outline panel on the right side of the editor.
3. Verify if there are any document symbols. If yes, the language server is connected to the editor.
4. If any feature is not working, make sure that the settings listed above are set to true (they are set to true by default). If a feature is not working, file an issue against the Language Server.

Procedure

1. Search for a netcoredbg debug configuration in the launch.json file.

   Example 6.1. Sample debug configuration

   {
    "type": "netcoredbg",
    "request": "launch",
    "program": "${workspaceFolder}/bin/Debug/<target-framework>/<project-name.dll>",
    "args": [],
    "name": ".NET Core Launch (console)",
    "stopAtEntry": false,
    "console": "internalConsole"
   }

2. Test the autocompletion feature within the braces of the configuration section of the launch.json file. If you can find netcoredbg, the Che-Theia plug-in is correctly initialized. If not, see Checking important logs.

1. Open a terminal inside the vscode-apache-camel<xxx> container.

2. Run the ps aux | grep java command. The following is an example language server process:

   java -jar /tmp/vscode-unpacked/camel-tooling.vscode-apache-camel.latest.euqhbmepxd.camel-tooling.vscode-apache-camel-0.0.14.vsix/extension/jars/language-server.jar

3. If you cannot find it, see Checking important logs.