| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Viewing Che workspaces logs :: Eclipse Che Documentation</title> |
| <link rel="canonical" href="https://www.eclipse.org/che/docs/che-7/end-user-guide/viewing-che-workspaces-logs/"> |
| <meta name="keywords" content="administration-guide, viewing-che-workspaces-logs"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="stylesheet" href="../../../_/css/site.css"> |
| <link rel="stylesheet" href="../../../_/css/extra.css"> |
| <link rel="stylesheet" href="../../../_/font-awesome-4.7.0/css/font-awesome.min.css"> |
| <link rel="icon" href="../../../favicon.ico" type="image/x-icon"> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-37306001-2"></script> |
| <script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','UA-37306001-2')</script> |
| <script>var uiRootPath = '../../../_'</script> |
| </head> |
| <body class="article"> |
| <header class="header" role="banner"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <div class="navbar-item"> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| <img src="../../../_/img/icon-eclipse-che.svg" class="navbar-logo" alt="Eclipse Che logo"> |
| <a href="https://www.eclipse.org/che/docs">Eclipse Che Documentation</a> |
| </div> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <div class="navbar-end"> |
| <div class="navbar-item hide-for-print"> |
| <script async src="https://cse.google.com/cse.js?cx=002898025167115630151:gnr5edrg2eo"></script> |
| <div class="gcse-searchbox" enableAutoComplete="true"></div> |
| </div> |
| <a class="navbar-item" href="https://www.eclipse.org/che/docs">Home</a> |
| <a class="navbar-item" href="https://che.eclipse.org/">Blog</a> |
| <a class="navbar-item" href="https://github.com/eclipse/che">Source Code</a> |
| </div> |
| </div> |
| </nav> |
| <div class="gcse-searchresults"></div> |
| </header><div class="body"> |
| <div class="nav-container" data-component="che-7" data-version="master"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../overview/introduction-to-eclipse-che/">Introduction to Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../overview/che-architecture/">Che architecture</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../hosted-che/hosted-che/">Eclipse Che hosted by Red Hat</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">End-user Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../navigating-che/">Navigating Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../navigating-che-using-the-dashboard/">Navigating Che: dashboard</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../importing-certificates-to-browsers/">Importing certificates to browsers</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../accessing-che-from-openshift-developer-perspective/">Navigating Che from OpenShift Developer Perspective</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../che-theia-ide-basics/">Che-Theia IDE basics</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../defining-custom-commands-for-che-theia/">Defining custom commands for Che-Theia</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../version-control/">Version Control</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../che-theia-troubleshooting/">Che-Theia Troubleshooting</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode/">Differences in how Che-Theia Webview works on a single-host mode comparing to a multi-host mode</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../workspaces-overview/">Using developer workspaces</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../creating-a-workspace-from-code-sample/">Creating a workspace from code sample</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../creating-a-workspace-from-remote-devfile/">Creating a workspace from a remote devfile using the dashboard</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../creating-a-workspace-from-local-devfile-using-chectl/">Creating a workspace from local devfile using chectl</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../creating-a-workspace-by-importing-the-source-code-of-a-project/">Creating a workspace by importing the source code of a project</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../configuring-a-workspace-with-dashboard/">Configuring a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../running-a-workspace-with-dashboard/">Running a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../importing-kubernetes-applications-into-a-workspace/">Importing Kubernetes applications into a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../remotely-accessing-workspaces/">Remotely accessing workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../mounting-a-secret-as-a-file-or-an-environment-variable-into-a-workspace-container/">Mounting a secret as a file or an environment variable into a workspace container</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../authenticating-on-scm-server-with-a-personal-access-token/">Authenticating on SCM Server with a personal access token</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../authoring-devfiles/">Authoring devfiles</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../authoring-devfiles-version-1/">Authoring devfiles version 1</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../authoring-devfiles-version-2/">Authoring devfiles version 2</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../customizing-developer-environments/">Customizing developer environments</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../what-is-a-che-theia-plug-in/">What is a Che-Theia plug-in</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../adding-a-vs-code-extension-to-a-workspace/">Adding a VS Code extension to a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../adding-a-vs-code-extension-to-the-che-plugin-registry/">Adding a VS Code extension to the Che plug-ins registry</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../publishing-metadata-for-a-vs-code-extension/">Publishing a VS Code extension</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../testing-a-visual-studio-code-extension-in-che/">Testing a VS Code extension in Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../using-alternative-ides-in-che/">Using alternative IDEs in Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../support-for-jetbrains-ides/">JetBrains IDEs</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../using-jetbrains-intellij-idea-community-edition/">Using IntelliJ Idea Community Edition</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../using-jetbrains-intellij-idea-ultimate-edition/">Using IntelliJ Idea Ultimate Edition</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../configuring-an-existing-workspace-to-use-intellij-idea/">Configuring an existing workspace to use IntelliJ IDEA</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../using-jetbrains-webstorm/">Using WebStorm</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../provisioning-jetbrains-activation-code-for-offline-use/">Provisioning activation code for offline use</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../support-for-theia-based-ides/">Theia-based IDEs</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../adding-tools-to-che-after-creating-a-workspace/">Adding tools to Che after creating a workspace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-private-container-registries/">Using private container registries</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../using-artifact-repositories-in-a-restricted-environment/">Using artifact repositories in a restricted environment</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-maven-artifact-repositories/">Using Maven artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-gradle-artifact-repositories/">Using Gradle artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-python-artifact-repositories/">Using Python artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-go-artifact-repositories/">Using Go artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-nuget-artifact-repositories/">Using NuGet artifact repositories</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../using-npm-artifact-repositories/">Using npm artifact repositories</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../troubleshooting-che/">Troubleshooting Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item is-current-page" data-depth="2"> |
| <a class="nav-link" href="./">Viewing Che workspaces logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../investigating-failures-at-a-workspace-start-using-the-verbose-mode/">Troubleshooting workspace start failures</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../troubleshooting-network-problems/">Troubleshooting network problems</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Installation Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../installation-guide/supported-platforms/">Supported platforms</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../installation-guide/configuring-the-che-installation/">Configuring the Che installation</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/installing-che/">Installing Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/installing-che-in-cloud/">Installing Che in cloud</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-operatorhub/">Installing Che on OpenShift 4 using OperatorHub</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-cli/">Installing Che on OpenShift 4 using CLI</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-3-using-the-operator/">Installing Che on OpenShift 3</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-kubespray/">Installing Che on Kubespray</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-aws/">Installing Che on AWS</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-google-cloud-platform/">Installing Che on Google Cloud</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-microsoft-azure/">Installing Che on Microsoft Azure</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/installing-che-locally/">Installing Che locally</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-codeready-containers/">Installing Che on CodeReady Containers</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-docker-desktop/">Installing Che on Docker Desktop</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-minikube/">Installing Che on Minikube</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-minishift/">Installing Che on Minishift</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../installation-guide/installing-che-on-kind/">Installing Che on Kind</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/using-the-chectl-management-tool/">Using the chectl management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/installing-che-in-a-restricted-environment/">Installing Che in restricted environment</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/advanced-configuration/">Advanced configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/advanced-configuration-options-for-the-che-server-component/">Advanced configuration options for Che server</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-namespace-strategies/">Configuring workspace target namespace</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-storage-strategies/">Configuring storage strategies</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-storage-types/">Configuring storage types</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-run/">Configuring the number of workspaces that a user can run</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-create/">Configuring the number of workspaces that a user can create</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-workspace-exposure-strategies/">Configuring workspace exposure strategies</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-workspaces-nodeselector/">Configuring workspaces nodeSelector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-che-hostname/">Configuring Che hostname</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-ingresses/">Configuring Kubernetes Ingress</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/configuring-routes/">Configuring OpenShift Route</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/">Deploying Che with support for Git repositories with self-signed certificates</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/installing-che-using-storage-classes/">Installing Che using storage classes</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/importing-untrusted-tls-certificates/">Importing untrusted TLS certificates to Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/switching-between-external-and-internal-communication/">Switching between external and internal ways in inter-component communication</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page/">Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container/">Mounting a secret as a file or an environment variable into a Eclipse Che container</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/enabling-dev-workspace-engine/">Enabling Dev Workspace engine</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/upgrading-che/">Upgrading Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/upgrading-che-using-operatorhub/">Upgrading Che using OperatorHub</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool/">Upgrading Che using the CLI management tool</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool-in-restricted-environment/">Upgrading Che in restricted environment</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/upgrading-che-namespace-strategies-other-than-per-user/">Updating Che namespace strategies other than 'per user'</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../installation-guide/uninstalling-che/">Uninstalling Che</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-web-console/">Using the OpenShift web console</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-cli/">Using OpenShift CLI</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../installation-guide/uninstalling-che-after-chectl-installation/">Using chectl</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Administration Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/che-architecture-overview/">Che architecture</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/che-workspace-controller/">Che workspace controller</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/che-workspaces-architecture/">Che workspaces architecture</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/calculating-che-resource-requirements/">Calculating Che resource requirements</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/customizing-the-registries/">Customizing the registries</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/building-custom-registry-images/">Building custom registry images</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/running-custom-registries/">Running custom registries</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/retrieving-che-logs/">Retrieving Che logs</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-server-logging/">Configuring server logging</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-kubernetes-events/">Accessing Kubernetes events on OpenShift</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-operator-events/">Viewing the Operator events on OpenShift</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-che-server-logs/">Viewing Che server logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-external-service-logs/">Viewing external service logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/viewing-plug-in-broker-logs/">Viewing Plug-in broker logs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/collecting-logs-using-chectl/">Collecting logs using chectl</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/monitoring-che/">Monitoring Che</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../administration-guide/tracing-che/">Tracing Che</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/backup-and-disaster-recovery/">Backup and disaster recovery</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/external-database-setup/">External database setup</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/persistent-volumes-backups/">Persistent Volumes backups</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/defining-the-list-of-images-to-pull/">Defining the list of images</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/defining-the-memory-parameters-for-the-image-puller/">Defining the memory settings</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-using-che-operator/">Installing using the Che Operator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-the-image-puller-operator/">Installing using the Kubernetes Image Puller Operator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-operatorhub/">Installing on OpenShift 4</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-openshift-templates/">Installing on OpenShift 3</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-helm/">Installing using Helm</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../administration-guide/managing-identities-and-authorizations/">Managing identities and authorizations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/authenticating-users/">Authenticating users</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/authorizing-users/">Authorizing users</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-authorization/">Configuring authorization</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/configuring-openshift-oauth/">Configuring OpenShift OAuth</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../administration-guide/removing-user-data/">Removing user data</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Contributor Guide</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/branding-che-theia/">Branding Che-Theia</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/developing-che-theia-plug-ins/">Developing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/testing-che-theia-plug-ins/">Testing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/publishing-che-theia-plug-ins/">Publishing Che-Theia plug-ins</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-language/">Adding support for a new language</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-debugger/">Adding support for a new debugger</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../contributor-guide/che-extensibility-reference/">Che extensibility reference</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/che-extension-points/">Che extension points</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/che-theia-plug-in-api/">Che-Theia plug-in API</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/debug-adapter-protocol/">Debug Adapter Protocol</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../contributor-guide/language-server-protocol/">Language Server Protocol</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Extensions</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../extensions/eclipse-che4z/">Eclipse Che4z</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../extensions/openshift-connector-overview/">OpenShift Connector</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/features-of-openshift-connector/">Features of OpenShift Connector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/installing-openshift-connector-in-che/">Installing OpenShift Connector in Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/authenticating-with-openshift-connector-from-che/">Authenticating with OpenShift Connector from Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/creating-components-with-openshift-connector-in-che/">Creating Components with OpenShift Connector in Eclipse Che</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/connecting-source-code-from-github-to-a-openshift-component-using-openshift-connector/">Connecting source code from GitHub to a OpenShift Component</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../extensions/telemetry/">Telemetry</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/creating-a-telemetry-plugin/">Creating A Telemetry Plugin</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../extensions/the-woopra-telemetry-plugin/">The Woopra Telemetry Plugin</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../extensions/java-lombok/">Java Lombok</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../../glossary/che-glossary/">Che glossary</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">Documentation</span> |
| <span class="version">master</span> |
| </div> |
| <ul class="components"> |
| <li class="component is-current"> |
| <a class="title" href="../../overview/introduction-to-eclipse-che/">Documentation</a> |
| <ul class="versions"> |
| <li class="version is-current is-latest"> |
| <a href="../../overview/introduction-to-eclipse-che/">master</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main class="article"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../overview/introduction-to-eclipse-che/" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></li> |
| <li>End-user Guide</li> |
| <li><a href="../troubleshooting-che/">Troubleshooting Che</a></li> |
| <li><a href="./">Viewing Che workspaces logs</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/eclipse/che-docs/edit/master/modules/end-user-guide/pages/viewing-che-workspaces-logs.adoc">Edit this Page</a></div> |
| </div> |
| <div class="content"> |
| <aside class="toc sidebar" data-title="Contents" data-levels="2"> |
| <div class="toc-menu"></div> |
| </aside> |
| <article class="doc"> |
| <h1 class="page">Viewing Che workspaces logs</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This section describes how to view Che workspaces logs.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="viewing-logs-from-language-servers-and-debug-adapters_che"><a class="anchor" href="#viewing-logs-from-language-servers-and-debug-adapters_che"></a>Viewing logs from language servers and debug adapters</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="checking-important-logs_che"><a class="anchor" href="#checking-important-logs_che"></a>Checking important logs</h3> |
| <div class="paragraph"> |
| <p>This section describes how to check important logs.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>In the OpenShift web console, click <strong>Applications</strong> → <strong>Pods</strong> to see a list of all the active workspaces.</p> |
| </li> |
| <li> |
| <p>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.</p> |
| </li> |
| <li> |
| <p>Choose a container and click the container name.</p> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>The most important logs are the <code>theia-ide</code> container and the plug-ins container logs.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </li> |
| <li> |
| <p>On the container screen, navigate to the <strong>Logs</strong> section.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="detecting-memory-problems_che"><a class="anchor" href="#detecting-memory-problems_che"></a>Detecting memory problems</h3> |
| <div class="paragraph"> |
| <p>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:</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">The plug-in container runs out of memory</dt> |
| <dd> |
| <p>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 <code>OOMKilled</code>, which implies that the processes in the container requested more memory than is available in the container.</p> |
| </dd> |
| <dt class="hdlist1">A process inside the container runs out of memory without the container noticing this</dt> |
| <dd> |
| <p>For example, the Java language server (Eclipse JDT Language Server, started by the <code>vscode-java</code> extension) throws an <strong>OutOfMemoryException</strong>. 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.</p> |
| <div class="paragraph"> |
| <p>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.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="logging-the-client-server-traffic-for-debug-adapters_che"><a class="anchor" href="#logging-the-client-server-traffic-for-debug-adapters_che"></a>Logging the client-server traffic for debug adapters</h3> |
| <div class="paragraph"> |
| <p>This section describes how to log the exchange between Che-Theia and a debug adapter into the <strong>Output</strong> view.</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Prerequisites</div> |
| <ul> |
| <li> |
| <p>A debug session must be started for the <strong>Debug adapters</strong> option to appear in the list.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Click <strong>File</strong> → <strong>Settings</strong> and then <strong>open Preferences</strong>.</p> |
| </li> |
| <li> |
| <p>Expand the <strong>Debug</strong> section in the <strong>Preferences</strong> view.</p> |
| </li> |
| <li> |
| <p>Set the <strong>trace</strong> preference value to <code>true</code> (default is <code>false</code>).</p> |
| <div class="paragraph"> |
| <p>All the communication events are logged.</p> |
| </div> |
| </li> |
| <li> |
| <p>To watch these events, click <strong>View → Output</strong> and select <strong>Debug adapters</strong> from the drop-down list at the upper right corner of the <strong>Output</strong> view.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/logging-the-client-server-traffic-for-debug-adapters.png" alt="logging the client server traffic for debug adapters"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-python_che"><a class="anchor" href="#viewing-logs-for-python_che"></a>Viewing logs for Python</h3> |
| <div class="paragraph"> |
| <p>This section describes how to view logs for the Python language server.</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Procedure</div> |
| <ul> |
| <li> |
| <p>Navigate to the <strong>Output</strong> view and select <strong>Python</strong> in the drop-down list.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-logs-for-python.png" alt="viewing logs for python"> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-go_che"><a class="anchor" href="#viewing-logs-for-go_che"></a>Viewing logs for Go</h3> |
| <div class="paragraph"> |
| <p>This section describes how to view logs for the Go language server.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="finding-the-go-path_che"><a class="anchor" href="#finding-the-go-path_che"></a>Finding the Go path</h4> |
| <div class="paragraph"> |
| <p>This section describes how to find where the <code>GOPATH</code> variable points to.</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Procedure</div> |
| <ul> |
| <li> |
| <p>Execute the <code>Go: Current GOPATH</code> command.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/finding-the-gopath.png" alt="Finding the Go path"> |
| </div> |
| </div> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-gopath.png" alt="Viewing the Go path"> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-debug-console-log-for-go_che"><a class="anchor" href="#viewing-debug-console-log-for-go_che"></a>Viewing the Debug Console log for Go</h4> |
| <div class="paragraph"> |
| <p>This section describes how to view the log output from the Go debugger.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Set the <code>showLog</code> attribute to <code>true</code> in the debug configuration.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{ |
| "version": "0.2.0", |
| "configurations": [ |
| { |
| "type": "go", |
| "showLog": true |
| .... |
| } |
| ] |
| }</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>To enable debugging output for a component, add the package to the comma-separated list value of the <code>logOutput</code> attribute:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{ |
| "version": "0.2.0", |
| "configurations": [ |
| { |
| "type": "go", |
| "showLog": true, |
| "logOutput": "debugger,rpc,gdbwire,lldbout,debuglineerr" |
| .... |
| } |
| ] |
| }</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>The debug console prints the additional information in the debug console.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-debug-console-log-for-go.png" alt="viewing debug console log for go"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-go-logs-output-in-the-output-panel_che"><a class="anchor" href="#viewing-go-logs-output-in-the-output-panel_che"></a>Viewing the Go logs output in the Output panel</h4> |
| <div class="paragraph"> |
| <p>This section describes how to view the Go logs output in the <strong>Output</strong> panel.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Navigate to the <strong>Output</strong> view.</p> |
| </li> |
| <li> |
| <p>Select <strong>Go</strong> in the drop-down list.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-go-logs-output-in-the-output-panel.png" alt="viewing go logs output in the output panel"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-the-nodedebug-nodedebug2-adapter_che"><a class="anchor" href="#viewing-logs-for-the-nodedebug-nodedebug2-adapter_che"></a>Viewing logs for the NodeDebug NodeDebug2 adapter</h3> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>No specific diagnostics exist other than the general ones.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-typescript_che"><a class="anchor" href="#viewing-logs-for-typescript_che"></a>Viewing logs for Typescript</h3> |
| <div class="sect3"> |
| <h4 id="enabling-the-label-switched-protocol-lsp-tracing_che"><a class="anchor" href="#enabling-the-label-switched-protocol-lsp-tracing_che"></a>Enabling the label switched protocol (LSP) tracing</h4> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>To enable the tracing of messages sent to the Typescript (TS) server, in the <strong>Preferences</strong> view, set the <code>typescript.tsserver.trace</code> attribute to <code>verbose</code>. Use this to diagnose the TS server issues.</p> |
| </li> |
| <li> |
| <p>To enable logging of the TS server to a file, set the <code>typescript.tsserver.log</code> attribute to <code>verbose</code>. Use this log to diagnose the TS server issues. The log contains the file paths.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-typescript-language-server-log_che"><a class="anchor" href="#viewing-typescript-language-server-log_che"></a>Viewing the Typescript language server log</h4> |
| <div class="paragraph"> |
| <p>This section describes how to view the Typescript language server log.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>To get the path to the log file, see the Typescript <strong>Output</strong> console:</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/finding-the-typescript-language-server-log.png" alt="finding the typescript language server log"> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>To open log file, use the <strong>Open TS Server log</strong> command.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-typescript-language-server-log.png" alt="viewing typescript language server log"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-typescript-logs-output-in-the-output-panel_che"><a class="anchor" href="#viewing-typescript-logs-output-in-the-output-panel_che"></a>Viewing the Typescript logs output in the Output panel</h4> |
| <div class="paragraph"> |
| <p>This section describes how to view the Typescript logs output in the <strong>Output</strong> panel.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Navigate to the <strong>Output</strong> view</p> |
| </li> |
| <li> |
| <p>Select <strong>TypeScript</strong> in the drop-down list.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-typescript-logs-output-in-the-output-panel.png" alt="viewing typescript logs output in the output panel"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-java_che"><a class="anchor" href="#viewing-logs-for-java_che"></a>Viewing logs for Java</h3> |
| <div class="paragraph"> |
| <p>Other than the general diagnostics, there are <a href="https://github.com/redhat-developer/vscode-java">Language Support for Java (Eclipse JDT Language Server)</a> plug-in actions that the user can perform.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-eclipse-jdt-language-server_che"><a class="anchor" href="#verifying-the-state-of-the-eclipse-jdt-language-server_che"></a>Verifying the state of the Eclipse JDT Language Server</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>Check if the container that is running the Eclipse JDT Language Server plug-in is running the Eclipse JDT Language Server main process.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Open a terminal in the container that is running the Eclipse JDT Language Server plug-in (an example name for the container: <code>vscode-javaxxx</code>).</p> |
| </li> |
| <li> |
| <p>Inside the terminal, run the <code>ps aux | grep jdt</code> command to check if the Eclipse JDT Language Server process is running in the container. If the process is running, the output is:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>usr/lib/jvm/default-jvm/bin/java --add-modules=ALL-SYSTEM --add-opens java.base/java.util</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This message also shows the VSCode Java extension used. If it is not running, the language server has not been started inside the container.</p> |
| </div> |
| </li> |
| <li> |
| <p>Check all logs described in <a href="#checking-important-logs_che">Checking important logs</a></p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-eclipse-jdt-language-server-features_che"><a class="anchor" href="#verifying-the-eclipse-jdt-language-server-features_che"></a>Verifying the Eclipse JDT Language Server features</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>If the Eclipse JDT Language Server process is running, check if the language server features are working:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Open a Java file and use the hover or autocomplete functionality. In case of an erroneous file, the user sees Java in the <strong>Outline</strong> view or in the <strong>Problems</strong> view.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-java-language-server-log_che"><a class="anchor" href="#viewing-java-language-server-log_che"></a>Viewing the Java language server log</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>The Eclipse JDT Language Server has its own workspace where it logs errors, information about executed commands, and events.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>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 <strong>Java: Open Java Language Server log file</strong> command.</p> |
| </li> |
| <li> |
| <p>Run <code>cat <em><PATH_TO_LOG_FILE></em></code> where <code>PATH_TO_LOG_FILE</code> is |
| <code>/home/theia/.theia/workspace-storage/<em><workspace_name></em>/redhat.java/jdt_ws/.metadata/.log</code>.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="logging-the-java-language-server-protocol-lsp-messages_che"><a class="anchor" href="#logging-the-java-language-server-protocol-lsp-messages_che"></a>Logging the Java language server protocol (LSP) messages</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To log the LSP messages to the VS Code <strong>Output</strong> view, enable tracing by setting the <code>java.trace.server</code> attribute to <code>verbose</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <div class="title">Additional resources</div> |
| <p>For troubleshooting instructions, see the <a href="https://github.com/redhat-developer/vscode-java">VS Code Java Github repository</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-intelephense_che"><a class="anchor" href="#viewing-logs-for-intelephense_che"></a>Viewing logs for Intelephense</h3> |
| <div class="sect3"> |
| <h4 id="logging-the-intelephense-client-server-communication_che"><a class="anchor" href="#logging-the-intelephense-client-server-communication_che"></a>Logging the Intelephense client-server communication</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To configure the PHP Intelephense language support to log the client-server communication in the <strong>Output</strong> view:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Click <strong>File → Settings</strong>.</p> |
| </li> |
| <li> |
| <p>Open the <strong>Preferences</strong> view.</p> |
| </li> |
| <li> |
| <p>Expand the <strong>Intelephense</strong> section and set the <code>trace.server.verbose</code> preference value to <code>verbose</code> to see all the communication events (the default value is <code>off</code>).</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-intelephense-events-in-the-output-panel_che"><a class="anchor" href="#viewing-intelephense-events-in-the-output-panel_che"></a>Viewing Intelephense events in the Output panel</h4> |
| <div class="paragraph"> |
| <p>This procedure describes how to view Intelephense events in the <strong>Output</strong> panel.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Click <strong>View → Output</strong></p> |
| </li> |
| <li> |
| <p>Select <strong>Intelephense</strong> in the drop-down list for the <strong>Output</strong> view.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-intelephense-events-in-the-output-panel.png" alt="viewing intelephense events in the output panel"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-php-debug_che"><a class="anchor" href="#viewing-logs-for-php-debug_che"></a>Viewing logs for PHP-Debug</h3> |
| <div class="paragraph"> |
| <p>This procedure describes how to configure the PHP Debug plug-in to log the PHP Debug plug-in diagnostic messages into the <strong>Debug Console</strong> view. Configure this before the start of the debug session.</p> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>In the <code>launch.json</code> file, add the <code>"log": true</code> attribute to the <code>php</code> configuration.</p> |
| </li> |
| <li> |
| <p>Start the debug session.</p> |
| </li> |
| <li> |
| <p>The diagnostic messages are printed into the <strong>Debug Console</strong> view along with the application output.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-logs-for-php-debug.png" alt="viewing logs for php debug"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-xml_che"><a class="anchor" href="#viewing-logs-for-xml_che"></a>Viewing logs for XML</h3> |
| <div class="paragraph"> |
| <p>Other than the general diagnostics, there are XML plug-in specific actions that the user can perform.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-xml-language-server_che"><a class="anchor" href="#verifying-the-state-of-the-xml-language-server_che"></a>Verifying the state of the XML language server</h4> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Open a terminal in the container named <code>vscode-xml-<em><xxx></em></code>.</p> |
| </li> |
| <li> |
| <p>Run <code>ps aux | grep java</code> to verify that the XML language server has started. If the process is running, the output is:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>java ***/org.eclipse.ls4xml-uber.jar`</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If is not, see the <a href="#checking-important-logs_che">Checking important logs</a> chapter.</p> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="checking-xml-language-server-feature-flags_che"><a class="anchor" href="#checking-xml-language-server-feature-flags_che"></a>Checking XML language server feature flags</h4> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Check if the features are enabled. The XML plug-in provides multiple settings that can enable and disable features:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>xml.format.enabled</code>: Enable the formatter</p> |
| </li> |
| <li> |
| <p><code>xml.validation.enabled</code>: Enable the validation</p> |
| </li> |
| <li> |
| <p><code>xml.documentSymbols.enabled</code>: Enable the document symbols</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p>To diagnose whether the XML language server is working, create a simple XML element, such as <code><hello></hello></code>, and confirm that it appears in the <strong>Outline</strong> panel on the right.</p> |
| </li> |
| <li> |
| <p>If the document symbols do not show, ensure that the <code>xml.documentSymbols.enabled</code> attribute is set to <code>true</code>. If it is <code>true</code>, 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.</p> |
| </li> |
| <li> |
| <p>Ensure that the features that the user needs, are set to <code>true</code> in the settings (they are set to <code>true</code> by default). If any of the features are not working, or not working as expected, file an issue against the |
| <a href="https://github.com/angelozerr/lsp4xml">Language Server</a>.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="enabling-xml-language-server-protocol-lsp-tracing_che"><a class="anchor" href="#enabling-xml-language-server-protocol-lsp-tracing_che"></a>Enabling XML Language Server Protocol (LSP) tracing</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To log LSP messages to the VS Code <strong>Output</strong> view, enable tracing by setting the <code>xml.trace.server</code> attribute to <code>verbose</code>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-xml-language-server-log_che"><a class="anchor" href="#viewing-xml-language-server-log_che"></a>Viewing the XML language server log</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>The log from the language server can be found in the plug-in sidecar at <code>/home/theia/.theia/workspace-storage/<workspace_name>/redhat.vscode-xml/lsp4xml.log</code>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-yaml_che"><a class="anchor" href="#viewing-logs-for-yaml_che"></a>Viewing logs for YAML</h3> |
| <div class="paragraph"> |
| <p>This section describes the YAML plug-in specific actions that the user can perform, in addition to the general diagnostics ones.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-yaml-language-server_che"><a class="anchor" href="#verifying-the-state-of-the-yaml-language-server_che"></a>Verifying the state of the YAML language server</h4> |
| <div class="paragraph"> |
| <p>This section describes how to verify the state of the YAML language server.</p> |
| </div> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>Check if the container running the YAML plug-in is running the YAML language server.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>In the editor, open a terminal in the container that is running the YAML plug-in (an example name of the container: <code>vscode-yaml-<em><xxx></em></code>).</p> |
| </li> |
| <li> |
| <p>In the terminal, run the <code>ps aux | grep node</code> command. This command searches all the node processes running in the current container.</p> |
| </li> |
| <li> |
| <p>Verify that a command <code>node <strong><strong></strong></strong>**/server.js</code> is running.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/verifying-the-state-of-the-yaml-language-server.png" alt="verifying the state of the yaml language server"> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>node <strong><strong></strong></strong>**/server.js</code> 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 <a href="#checking-important-logs_che">Checking important logs</a>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="checking-the-yaml-language-server-feature-flags_che"><a class="anchor" href="#checking-the-yaml-language-server-feature-flags_che"></a>Checking the YAML language server feature flags</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To check the feature flags:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Check if the features are enabled. The YAML plug-in provides multiple settings that can enable and disable features, such as:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>yaml.format.enable</code>: Enables the formatter</p> |
| </li> |
| <li> |
| <p><code>yaml.validate</code>: Enables validation</p> |
| </li> |
| <li> |
| <p><code>yaml.hover</code>: Enables the hover function</p> |
| </li> |
| <li> |
| <p><code>yaml.completion</code>: Enables the completion function</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p>To check if the plug-in is working, type the simplest YAML, such as <code>hello: world</code>, and then open the <strong>Outline</strong> panel on the right side of the editor.</p> |
| </li> |
| <li> |
| <p>Verify if there are any document symbols. If yes, the language server is connected to the editor.</p> |
| </li> |
| <li> |
| <p>If any feature is not working, make sure that the settings listed above are set to <code>true</code> (they are set to <code>true</code> by default). If a feature is not working, file an issue against the <a href="https://github.com/redhat-developer/yaml-language-server">Language Server</a>.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="enabling-yaml-language-server-protocol-lsp-tracing_che"><a class="anchor" href="#enabling-yaml-language-server-protocol-lsp-tracing_che"></a>Enabling YAML Language Server Protocol (LSP) tracing</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To log LSP messages to the VS Code <strong>Output</strong> view, enable tracing by setting the <code>yaml.trace.server</code> attribute to <code>verbose</code>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-dotnet-with-omnisharp-theia-plug-in_che"><a class="anchor" href="#viewing-logs-for-dotnet-with-omnisharp-theia-plug-in_che"></a>Viewing logs for .NET with OmniSharp-Theia plug-in</h3> |
| <div class="sect3"> |
| <h4 id="omnisharp-theia-plug-in_che"><a class="anchor" href="#omnisharp-theia-plug-in_che"></a>OmniSharp-Theia plug-in</h4> |
| <div class="paragraph"> |
| <p>Che uses the OmniSharp-Theia plug-in as a remote plug-in. It is located at |
| <a href="https://github.com/redhat-developer/omnisharp-theia-plugin">github.com/redhat-developer/omnisharp-theia-plugin</a>. In case of an issue, report it, or contribute your fix in the repository.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This plug-in registers <a href="https://github.com/OmniSharp/omnisharp-roslyn">omnisharp-roslyn</a> as a language server and provides project dependencies and language syntax for C# applications.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The language server runs on .NET SDK 2.2.105.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-omnisharp-theia-plug-in-language-server_che"><a class="anchor" href="#verifying-the-state-of-the-omnisharp-theia-plug-in-language-server_che"></a>Verifying the state of the OmniSharp-Theia plug-in language server</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>To check if the container running the OmniSharp-Theia plug-in is running OmniSharp, execute the <code>ps aux | grep OmniSharp.exe</code> command. If the process is running, the following is an example output:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/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</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If the output is different, the language server has not started inside the container. Check the logs described in <a href="#checking-important-logs_che">Checking important logs</a>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="checking-omnisharp-theia-plug-in-language-server-features_che"><a class="anchor" href="#checking-omnisharp-theia-plug-in-language-server-features_che"></a>Checking OmniSharp Che-Theia plug-in language server features</h4> |
| <div class="ulist"> |
| <div class="title">Procedure</div> |
| <ul> |
| <li> |
| <p>If the OmniSharp.exe process is running, check if the language server features are working by opening a <code>.cs</code> file and trying the hover or completion features, or opening the <strong>Problems</strong> or <strong>Outline</strong> view.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-omnisharp-theia-plug-in-logs-in-the-output-panel_che"><a class="anchor" href="#viewing-omnisharp-theia-plug-in-logs-in-the-output-panel_che"></a>Viewing OmniSharp-Theia plug-in logs in the Output panel</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>If <code>OmniSharp.exe</code> is running, it logs all information in the <strong>Output</strong> panel. To view the logs, open the <strong>Output</strong> view and select <strong>C#</strong> from the drop-down list.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in_che"><a class="anchor" href="#viewing-logs-for-dotnet-with-netcoredebugoutput-plug-in_che"></a>Viewing logs for .NET with NetcoredebugOutput plug-in</h3> |
| <div class="sect3"> |
| <h4 id="netcoredebugoutput-plug-in_che"><a class="anchor" href="#netcoredebugoutput-plug-in_che"></a>NetcoredebugOutput plug-in</h4> |
| <div class="paragraph"> |
| <p>The NetcoredebugOutput plug-in provides the <a href="https://github.com/Samsung/netcoredbg"><code>netcoredbg</code></a> tool. |
| This tool implements the VS Code Debug Adapter protocol and allows users to debug .NET applications under the .NET Core runtime.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The container where the NetcoredebugOutput plug-in is running contains .NET SDK v.2.2.105.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-netcoredebugoutput-plug-in_che"><a class="anchor" href="#verifying-the-state-of-the-netcoredebugoutput-plug-in_che"></a>Verifying the state of the NetcoredebugOutput plug-in</h4> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Search for a <code>netcoredbg</code> debug configuration in the <code>launch.json</code> file.</p> |
| <div class="exampleblock"> |
| <div class="title">Example 1. Sample debug configuration</div> |
| <div class="content"> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{ |
| "type": "netcoredbg", |
| "request": "launch", |
| "program": "${workspaceFolder}/bin/Debug/<em><target-framework></em>/<em><project-name.dll></em>", |
| "args": [], |
| "name": ".NET Core Launch (console)", |
| "stopAtEntry": false, |
| "console": "internalConsole" |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Test the autocompletion feature within the braces of the <code>configuration</code> section of the <code>launch.json</code> file. If you can find <code>netcoredbg</code>, the Che-Theia plug-in is correctly initialized. If not, see <a href="#checking-important-logs_che">Checking important logs</a>.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel_che"><a class="anchor" href="#viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel_che"></a>Viewing <code>NetcoredebugOutput</code> plug-in logs in the Output panel</h4> |
| <div class="paragraph"> |
| <p>This section describes how to view <code>NetcoredebugOutput</code> plug-in logs in the <strong>Output</strong> panel.</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Procedure</div> |
| <ul> |
| <li> |
| <p>Open the <strong>Debug</strong> console.</p> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="../_images/logs/viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.png" alt="viewing netcoredebugoutput plug in logs in the output panel"> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-logs-for-camel_che"><a class="anchor" href="#viewing-logs-for-camel_che"></a>Viewing logs for Camel</h3> |
| <div class="sect3"> |
| <h4 id="verifying-the-state-of-the-camel-language-server_che"><a class="anchor" href="#verifying-the-state-of-the-camel-language-server_che"></a>Verifying the state of the Camel language server</h4> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>The user can inspect the log output of the sidecar container using the Camel language tools that are stored in the <code>vscode-apache-camel<em><xxx></em></code> Camel container.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To verify the state of the language server:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Open a terminal inside the <code>vscode-apache-camel<em><xxx></em></code> container.</p> |
| </li> |
| <li> |
| <p>Run the <code>ps aux | grep java</code> command. The following is an example language server process:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>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</pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>If you cannot find it, see <a href="#checking-important-logs_che">Checking important logs</a>.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="viewing-camel-logs-in-the-output-panel_che"><a class="anchor" href="#viewing-camel-logs-in-the-output-panel_che"></a>Viewing Camel logs in the Output panel</h4> |
| <div class="paragraph"> |
| <p>The Camel language server is a SpringBoot application that writes its log to the <code>$\{java.io.tmpdir}/log-camel-lsp.out</code> file. Typically, <code>$\{java.io.tmpdir}</code> points to the <code>/tmp</code> directory, so the filename is <code>/tmp/log-camel-lsp.out</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <div class="title">Procedure</div> |
| <p>The Camel language server logs are printed in the <strong>Output</strong> channel named <strong>Language Support for Apache Camel</strong>.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| 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. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="imageblock"> |
| <div class="content"> |
| <a class="image" href="../_images/logs/viewing-camel-logs-in-the-output-panel.png"><img src="../_images/logs/viewing-camel-logs-in-the-output-panel.png" alt="viewing camel logs in the output panel"></a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="viewing-che-theia-ide-logs_che"><a class="anchor" href="#viewing-che-theia-ide-logs_che"></a>Viewing Che-Theia IDE logs</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This section describes how to view Che-Theia IDE logs.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="viewing-che-theia-ide-logs-on-the-cli_che"><a class="anchor" href="#viewing-che-theia-ide-logs-on-the-cli_che"></a>Viewing Che-Theia editor logs using the OpenShift CLI</h3> |
| <div class="paragraph"> |
| <p>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).</p> |
| </div> |
| <div class="ulist"> |
| <div class="title">Prerequisites</div> |
| <ul> |
| <li> |
| <p>Che is deployed in an OpenShift cluster.</p> |
| </li> |
| <li> |
| <p>A workspace is created.</p> |
| </li> |
| <li> |
| <p>User is located in a Che installation namespace.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="olist arabic"> |
| <div class="title">Procedure</div> |
| <ol class="arabic"> |
| <li> |
| <p>Obtain the list of the available Pods:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ oc get pods</pre> |
| </div> |
| </div> |
| <div class="listingblock white-space-pre"> |
| <div class="title">Example</div> |
| <div class="content"> |
| <pre class="nowrap">$ oc get pods |
| NAME READY STATUS RESTARTS AGE |
| che-9-xz6g8 1/1 Running 1 15h |
| workspace0zqb2ew3py4srthh.go-cli-549cdcf69-9n4w2 4/4 Running 0 1h</pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Obtain the list of the available containers in the particular Pod:</p> |
| <div class="listingblock white-space-pre"> |
| <div class="content"> |
| <pre class="nowrap">$ oc get pods <em><name-of-pod></em> --output jsonpath='\{.spec.containers[*].name}'</pre> |
| </div> |
| </div> |
| <div class="listingblock white-space-pre"> |
| <div class="title">Example:</div> |
| <div class="content"> |
| <pre class="nowrap">$ oc get pods workspace0zqb2ew3py4srthh.go-cli-549cdcf69-9n4w2 -o |
| jsonpath='\{.spec.containers[*].name}' |
| > go-cli che-machine-exechr7 theia-idexzb vscode-gox3r</pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Get logs from the <code>theia/ide</code> container:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ oc logs --follow <em><name-of-pod></em> --container <em><name-of-container></em></pre> |
| </div> |
| </div> |
| <div class="listingblock white-space-pre"> |
| <div class="title">Example:</div> |
| <div class="content"> |
| <pre class="nowrap">$ 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</pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| </div> |
| </article> |
| </div> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div><a href="https://www.eclipse.org" target="_blank">Eclipse Foundation</a> | |
| <a href="https://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> | |
| <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> | |
| <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a> | |
| <a href="https://www.eclipse.org/legal" target="_blank">Legal Resources</a></div> |
| </footer> |
| |
| <script src="../../../_/js/site.js"></script> |
| <script async src="../../../_/js/vendor/highlight.js"></script> |
| </body> |
| </html> |
