Chapter 2. Retrieving CodeReady Workspaces logs For information about obtaining various types of logs in CodeReady Workspaces, see the following sections: Viewing OpenShift events Viewing CodeReady Workspaces server logs Viewing external service logs Viewing CodeReady Workspaces workspaces logs Viewing the plug-in broker logs Collecting Red Hat CodeReady Workspaces logs using crwctl 2.1. Accessing OpenShift events on OpenShift For high-level monitoring of OpenShift projects, view the OpenShift events that the project performs. This section describes how to access these events in the OpenShift web console. Prerequisites A running OpenShift web console. Procedure In the left panel of the OpenShift web console, click the Home Events . To view the list of all events for a particular project, select the project from the list. The details of the events for the current project are displayed. Additional resources For a list of OpenShift events, see Comprehensive List of Events in OpenShift documentation . 2.2. Viewing the state of the CodeReady Workspaces cluster deployment using OpenShift 4 CLI tools This section describes how to view the state of the CodeReady Workspaces cluster deployment using OpenShift 4 CLI tools. Prerequisites An instance of Red Hat CodeReady Workspaces running on OpenShift. An installation of the OpenShift command-line tool, oc . Procedure Run the following commands to select the crw project: Run the following commands to get the name and status of the Pods running in the selected project: Check that the status of all the Pods is Running . Example 2.1. Pods with status Running NAME READY STATUS RESTARTS AGE codeready-8495f4946b-jrzdc 0/1 Running 0 86s codeready-operator-578765d954-99szc 1/1 Running 0 42m keycloak-74fbfb9654-g9vp5 1/1 Running 0 4m32s postgres-5d579c6847-w6wx5 1/1 Running 0 5m14s To see the state of the CodeReady Workspaces cluster deployment, run: USD oc logs --tail=10 -f `(oc get pods -o name | grep operator)` Example 2.2. Logs of the Operator: time="2019-07-12T09:48:29Z" level=info msg="Exec successfully completed" time="2019-07-12T09:48:29Z" level=info msg="Updating eclipse-che CR with status: provisioned with OpenShift identity provider: true" time="2019-07-12T09:48:29Z" level=info msg="Custom resource eclipse-che updated" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: che" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: custom" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: Deployment, name: che" time="2019-07-12T09:48:30Z" level=info msg="Updating eclipse-che CR with status: CodeReady Workspaces API: Unavailable" time="2019-07-12T09:48:30Z" level=info msg="Custom resource eclipse-che updated" time="2019-07-12T09:48:30Z" level=info msg="Waiting for deployment che. Default timeout: 420 seconds" 2.3. Viewing CodeReady Workspaces server logs This section describes how to view the CodeReady Workspaces server logs using the command line. 2.3.1. Viewing the CodeReady Workspaces server logs using the OpenShift CLI This section describes how to view the CodeReady Workspaces server logs using the OpenShift CLI (command line interface). Procedure In the terminal, run the following command to get the Pods: Example To get the logs for a deployment, run the following command: Example 2.4. Viewing external service logs This section describes how the view the logs from external services related to CodeReady Workspaces server. 2.4.1. Viewing RH-SSO logs The RH-SSO OpenID provider consists of two parts: Server and IDE. It writes its diagnostics or error information to several logs. 2.4.1.1. Viewing the RH-SSO server logs This section describes how to view the RH-SSO OpenID provider server logs. Procedure In the OpenShift Web Console, click Deployments . In the Filter by label search field, type keycloak to see the RH-SSO logs. In the Deployment Configs section, click the keycloak link to open it. In the History tab, click the View log link for the active RH-SSO deployment. The RH-SSO logs are displayed. Additional resources See the active CodeReady Workspaces deployment log for diagnostics and error messages related to the RH-SSO IDE Server. 2.4.1.2. Viewing the RH-SSO client logs on Firefox This section describes how to view the RH-SSO IDE client diagnostics or error information in the Firefox WebConsole . Procedure Click Menu > WebDeveloper > WebConsole . 2.4.1.3. Viewing the RH-SSO client logs on Google Chrome This section describes how to view the RH-SSO IDE client diagnostics or error information in the Google Chrome Console tab. Procedure Click on Menu > More Tools > Developer Tools . Click on the Console tab. 2.4.2. Viewing the CodeReady Workspaces database logs This section describes how to view the database logs in {prod-shor}, such as PostgreSQL server logs. Procedure In the OpenShift Web Console, click Deployments . In the Find by label search field, type: app=che and press Enter component=postgres and Enter The OpenShift Web Console now searches base on those two keys and displays PostgreSQL logs. Click postgres deployment to open it. Click the View log link for the active PostgreSQL deployment. The OpenShift Web Console displays the database logs. Additional resources Some diagnostics or error messages related to the PostgreSQL server can be found in the active CodeReady Workspaces deployment log. For details to access the active CodeReady Workspaces deployments logs, see the Viewing the CodeReady Workspaces server logs section. 2.5. Viewing CodeReady Workspaces workspaces logs This section describes how to view CodeReady Workspaces workspaces logs. 2.5.1. Viewing Che-Theia IDE logs This section describes how to view Che-Theia IDE logs. 2.5.1.1. Viewing Che-Theia editor logs using the OpenShift CLI Observing Che-Theia editor logs helps to get a better understanding and insight over the plug-ins loaded by the editor. This section describes how to access the Che-Theia editor logs using the OpenShift CLI (command-line interface). Prerequisites CodeReady Workspaces is deployed in an OpenShift cluster. Verify the state of the deployment in the OpenShift logs. See Viewing the state of the CodeReady Workspaces cluster deployment using OpenShift 4 CLI tools . A workspace is created. User is located in a CodeReady Workspaces installation namespace. Procedure Obtain the list of the available Pods: Example Obtain the list of the available containers in the particular Pod: USD oc get pods <name-of-pod> --output jsonpath='\{.spec.containers[*].name}' Example: Get logs from the theia/ide container: Example: 2.5.2. Viewing logs from language servers and debug adapters 2.5.2.1. Checking important logs This section describes how to check important logs. Procedure In the OpenShift web console, click Applications Pods to see a list of all the active workspaces. Click on the name of the running Pod where the workspace is running. The Pod screen contains the list of all containers with additional information. Choose a container and click the container name. Tip The most important logs are the theia-ide container and the plug-ins container logs. On the container screen, navigate to the Logs section. Example The following is an output log of the sidecar container running the Java plug-in. 2.5.2.2. Detecting memory problems This section describes how to detect memory problems related to a plug-in running out of memory. The following are the two most common problems related to a plug-in running out of memory: The plug-in container runs out of memory This can happen during plug-in initialization when the container does not have enough RAM to execute the entrypoint of the image. The user can detect this in the logs of the plug-in container. In this case, the logs contain OOMKilled , which implies that the processes in the container requested more memory than is available in the container. A process inside the container runs out of memory without the container noticing this For example, the Java language server (Eclipse JDT Language Server, started by the vscode-java extension) throws an OutOfMemoryException . This can happen any time after the container is initialized, for example, when a plug-in starts a language server or when a process runs out of memory because of the size of the project it has to handle. To detect this problem, check the logs of the primary process running in the container. For example, to check the log file of Eclipse JDT Language Server for details, see the relevant plug-in-specific sections. 2.5.2.3. Logging the client-server traffic for debug adapters This section describes how to log the exchange between Che-Theia and a debug adapter into the Output view. Prerequisites A debug session must be started for the Debug adapters option to appear in the list. Procedure Click File Settings and then open Preferences . Expand the Debug section in the Preferences view. Set the trace preference value to true (default is false ). All the communication events are now logged. To watch these events, click View Output and select Debug adapters from the drop-down list at the upper right corner of the Output view. 2.5.2.4. Viewing logs for Python This section describes how to view logs for the Python language server. Procedure Navigate to the Output view and select Python in the drop-down list. 2.5.2.5. Viewing logs for Go This section describes how to view logs for the Go language server. 2.5.2.5.1. Finding the gopath This section describes how to find where the GOPATH variable points to. Procedure Execute the Go: Current GOPATH command. 2.5.2.5.2. Viewing the Debug Console log for Go This section describes how to view the log output from the Go debugger. Procedure Set the showLog attribute to true in the debug configuration. { "version": "0.2.0", "configurations": [ { "type": "go", "showLog": true .... } ] } 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" .... } ] } The debug console prints the additional information in the debug console. 2.5.2.5.3. Viewing the Go logs output in the Output panel This section describes how to view the Go logs output in the Output panel. Procedure Navigate to the Output view. Select Go in the drop-down list. 2.5.2.6. Viewing logs for the NodeDebug NodeDebug2 adapter Note There are no specific diagnostics other than the general ones. 2.5.2.7. Viewing logs for Typescript 2.5.2.7.1. Enabling the label switched protocol (LSP) tracing Procedure 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. 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. 2.5.2.7.2. Viewing the Typescript language server log This section describes how to view the Typescript language server log. Procedure To get the path to the log file, see the Typescript Output console: To open log file, use the Open TS Server log command. 2.5.2.7.3. Viewing the Typescript logs output in the Output panel This section describes how to view the Typescript logs output in the Output panel. Procedure Navigate to the Output view Select TypeScript in the drop-down list. 2.5.2.8. Viewing logs for Java Other than the general diagnostics, there are Language Support for Java (Eclipse JDT Language Server) plug-in actions that the user can perform. 2.5.2.8.1. Verifying the state of the Eclipse JDT Language Server Procedure Check if the container that is running the Eclipse JDT Language Server plug-in is running the Eclipse JDT Language Server main process. Open a terminal in the container that is running the Eclipse JDT Language Server plug-in (an example name for the container: vscode-javaxxx ). 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: This message also shows the VSCode Java extension used. If it is not running, the language server has not been started inside the container. Check all logs described in Checking important logs 2.5.2.8.2. Verifying the Eclipse JDT Language Server features Procedure If the Eclipse JDT Language Server process is running, check if the language server features are working: 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. 2.5.2.8.3. Viewing the Java language server log Procedure The Eclipse JDT Language Server has its own workspace where it logs errors, information about executed commands, and events. 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. 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 . 2.5.2.8.4. Logging the Java language server protocol (LSP) messages Procedure To log the LSP messages to the VS Code Output view, enable tracing by setting the java.trace.server attribute to verbose . Additional resources For troubleshooting instructions, see the VS Code Java Github repository . 2.5.2.9. Viewing logs for Intelephense 2.5.2.9.1. Logging the Intelephense client-server communication Procedure To configure the PHP Intelephense language support to log the client-server interexchange in the Output view: Click File Settings . Open the Preferences view. 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 ). 2.5.2.9.2. Viewing Intelephense events in the Output panel This procedure describes how to view Intelephense events in the Output panel. Procedure Click View Output Select Intelephense in the drop-down list for the Output view. 2.5.2.10. Viewing logs for PHP-Debug This procedure describes how to configure the PHP Debug plug-in to log the PHP Debug plug-in diagnostic messages into the Debug Console view. Configure this before the start of the debug session. Procedure In the launch.json file, add the "log": true attribute to the selected launch configuration. Start the debug session. The diagnostic messages are printed into the Debug Console view along with the application output. 2.5.2.11. Viewing logs for XML Other than the general diagnostics, there are XML plug-in specific actions that the user can perform. 2.5.2.11.1. Verifying the state of the XML language server Procedure Open a terminal in the container named vscode-xml- <xxx> . Run ps aux | grep java to verify that the XML language server has started. If the process is running, the output is: If is not, see the Checking important logs chapter. 2.5.2.11.2. Checking XML language server feature flags Procedure 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 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. 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. 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 . 2.5.2.11.3. Enabling XML Language Server Protocol (LSP) tracing Procedure To log LSP messages to the VS Code Output view, enable tracing by setting the xml.trace.server attribute to verbose . 2.5.2.11.4. Viewing the XML language server log Procedure The log from the language server can be found in the plug-in sidecar at /home/theia/.theia/workspace-storage/<workspace_name>/redhat.vscode-xml/lsp4xml.log . 2.5.2.12. Viewing logs for YAML This section describes the YAML plug-in specific actions that the user can perform, in addition to the general diagnostics ones. 2.5.2.12.1. Verifying the state of the YAML language server This section describes how to verify the state of the YAML language server. Procedure Check if the container running the YAML plug-in is running the YAML language server. 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> ). In the terminal, run the ps aux | grep node command. This command searches all the node processes running in the current container. Verify that a command node **/server.js is running. The node **/server.js running in the container indicates that the language server is running. If it is not running, the language server has not started inside the container. In this case, see Checking important logs . 2.5.2.12.2. Checking the YAML language server feature flags Procedure To check the feature flags: 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 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. Verify if there are any document symbols. If yes, the language server is connected to the editor. 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 . 2.5.2.12.3. Enabling YAML Language Server Protocol (LSP) tracing Procedure To log LSP messages to the VS Code Output view, enable tracing by setting the yaml.trace.server attribute to verbose . 2.5.2.13. Viewing logs for Dotnet with Omnisharp-Theia plug-in 2.5.2.13.1. Omnisharp-Theia plug-in CodeReady Workspaces uses the Omnisharp-Theia plug-in as a remote plug-in. It is located at github.com/redhat-developer/omnisharp-theia-plugin . In case of an issue, report it, or contribute your fix in the repository. This plug-in registers omnisharp-roslyn as a language server and provides project dependencies and language syntax for C# applications. The language server runs on .NET SDK 2.2.105. 2.5.2.13.2. Verifying the state of the Omnisharp-Theia plug-in language server Procedure To check if the container running the Omnisharp-Theia plug-in is running OmniSharp, execute the ps aux | grep OmniSharp.exe command. If the process is running, the following is an example output: If the output is different, the language server has not started inside the container. Check the logs described in Checking important logs . 2.5.2.13.3. Checking Omnisharp Che-Theia plug-in language server features Procedure If the OmniSharp.exe process is running, check if the language server features are working by opening a .cs file and trying the hover or completion features, or opening the Problems or Outline view. 2.5.2.13.4. Viewing Omnisharp-Theia plug-in logs in the Output panel Procedure If Omnisharp.exe is running, it logs all information in the Output panel. To view the logs, open the Output view and select C# from the drop-down list. 2.5.2.14. Viewing logs for Dotnet with NetcoredebugOutput plug-in 2.5.2.14.1. NetcoredebugOutput plug-in The NetcoredebugOutput plug-in provides netcoredbg , which implements the VS Code Debug Adapter protocol and allows users to debug .NET applications under the .NET Core runtime. Dotnet SDK v.2.2.105 is installed in the container where the Netcoredbg plug-in is running. 2.5.2.14.2. Verifying the state of the NetcoredebugOutput plug-in Procedure To test the plug-in initialization: Check if there is a netcoredbg debug configuration in the launch.json file. The following is an example debug configuration: { "type": "netcoredbg", "request": "launch", "program": "USD\{workspaceFolder}/bin/Debug/<target-framework>/<project-name.dll>", "args": [], "name": ".NET Core Launch (console)", "stopAtEntry": false, "console": "internalConsole" } To test if it exists, 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 . 2.5.2.14.3. Viewing NetcoredebugOutput plug-in logs in the Output panel This section describes how to view NetcoredebugOutput plug-in logs in the Output panel. Procedure Open the Debug console. 2.5.2.15. Viewing logs for Camel 2.5.2.15.1. Verifying the state of the Camel language server Procedure The user can inspect the log output of the sidecar container using the Camel language tools that are stored in the vscode-apache-camel <xxx> Camel container. To verify the state of the language server: Open a terminal inside the vscode-apache-camel <xxx> container. Run the ps aux | grep java command. The following is an example language server process: If you cannot find it, see Checking important logs . 2.5.2.15.2. Viewing Camel logs in the Output panel The Camel language server is a SpringBoot application that writes its log to the USD\{java.io.tmpdir}/log-camel-lsp.out file. Typically, USD\{java.io.tmpdir} points to the /tmp directory, so the filename is /tmp/log-camel-lsp.out . Procedure The Camel language server logs are printed in the Output channel named Language Support for Apache Camel . Note The output channel is created only at the first created log entry on the client side. It may be absent when everything is going well. 2.6. Viewing the plug-in broker logs This section describes how to view the plug-in broker logs. The che-plugin-broker Pod itself is deleted when its work is complete. Therefore, its event logs are only available while the workspace is starting. Procedure To see logged events from temporary Pods: Start a CodeReady Workspaces workspace. From the main OpenShift Container Platform screen, go to Workload Pods . Use the OpenShift terminal console located in the Pod's Terminal tab Verification step OpenShift terminal console displays the plug-in broker logs while the workspace is starting 2.7. Collecting logs using crwctl It is possible to get all Red Hat CodeReady Workspaces logs from a OpenShift cluster using the crwctl tool. crwctl server:start automatically starts collecting Red Hat CodeReady Workspaces servers logs during installation of Red Hat CodeReady Workspaces crwctl server:logs collects existing Red Hat CodeReady Workspaces server logs crwctl workspace:logs collects running workspace logs crwctl workspace:logs --follow starts collecting logs of all new workspaces

Commands:
oc project <project_name>
oc get pods
NAME READY STATUS RESTARTS AGE codeready-8495f4946b-jrzdc 0/1 Running 0 86s codeready-operator-578765d954-99szc 1/1 Running 0 42m keycloak-74fbfb9654-g9vp5 1/1 Running 0 4m32s postgres-5d579c6847-w6wx5 1/1 Running 0 5m14s
oc logs --tail=10 -f `(oc get pods -o name | grep operator)`
time="2019-07-12T09:48:29Z" level=info msg="Exec successfully completed" time="2019-07-12T09:48:29Z" level=info msg="Updating eclipse-che CR with status: provisioned with OpenShift identity provider: true" time="2019-07-12T09:48:29Z" level=info msg="Custom resource eclipse-che updated" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: che" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: custom" time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: Deployment, name: che" time="2019-07-12T09:48:30Z" level=info msg="Updating eclipse-che CR with status: CodeReady Workspaces API: Unavailable" time="2019-07-12T09:48:30Z" level=info msg="Custom resource eclipse-che updated" time="2019-07-12T09:48:30Z" level=info msg="Waiting for deployment che. Default timeout: 420 seconds"
oc get pods
oc get pods NAME READY STATUS RESTARTS AGE codeready-11-j4w2b 1/1 Running 0 3m
oc logs <name-of-pod>
oc logs codeready-11-j4w2b
oc get pods
oc get pods NAME READY STATUS RESTARTS AGE codeready-9-xz6g8 1/1 Running 1 15h workspace0zqb2ew3py4srthh.go-cli-549cdcf69-9n4w2 4/4 Running 0 1h
oc get pods <name-of-pod> --output jsonpath='\{.spec.containers[*].name}'
oc get pods workspace0zqb2ew3py4srthh.go-cli-549cdcf69-9n4w2 -o jsonpath='\{.spec.containers[*].name}' > go-cli che-machine-exechr7 theia-idexzb vscode-gox3r
oc logs --follow <name-of-pod> --container <name-of-container>
oc logs --follow workspace0zqb2ew3py4srthh.go-cli-549cdcf69-9n4w2 -container theia-idexzb >root INFO unzipping the plug-in 'task_plugin.theia' to directory: /tmp/theia-unpacked/task_plugin.theia root INFO unzipping the plug-in 'theia_yeoman_plugin.theia' to directory: /tmp/theia-unpacked/theia_yeoman_plugin.theia root WARN A handler with prefix term is already registered. root INFO [nsfw-watcher: 75] Started watching: /home/theia/.theia root WARN e.onStart is slow, took: 367.4600000013015 ms root INFO [nsfw-watcher: 75] Started watching: /projects root INFO [nsfw-watcher: 75] Started watching: /projects/.theia/tasks.json root INFO [4f9590c5-e1c5-40d1-b9f8-ec31ec3bdac5] Sync of 9 plugins took: 62.26000000242493 ms root INFO [nsfw-watcher: 75] Started watching: /projects root INFO [hosted-plugin: 88] PLUGIN_HOST(88) starting instance
{ "version": "0.2.0", "configurations": [ { "type": "go", "showLog": true . } ] }
{ "version": "0.2.0", "configurations": [ { "type": "go", "showLog": true, "logOutput": "debugger,rpc,gdbwire,lldbout,debuglineerr" . } ] }
usr/lib/jvm/default-jvm/bin/java --add-modules=ALL-SYSTEM --add-opens java.base/java.util
java ***/org.eclipse.ls4xml-uber.jar`
/tmp/theia-unpacked/redhat-developer.che-omnisharp-plugin.0.0.1.zcpaqpczwb.omnisharp_theia_plugin.theia/server/bin/mono /tmp/theia-unpacked/redhat-developer.che-omnisharp-plugin.0.0.1.zcpaqpczwb.omnisharp_theia_plugin.theia/server/omnisharp/OmniSharp.exe
{ "type": "netcoredbg", "request": "launch", "program": "USD\{workspaceFolder}/bin/Debug/<target-framework>/<project-name.dll>", "args": [], "name": ".NET Core Launch (console)", "stopAtEntry": false, "console": "internalConsole" }
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