docs/che-7/administration-guide/tracing-che/index.html - gerrit/www.eclipse.org/che - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>Tracing Che :: Eclipse Che Documentation</title>
     <link rel="canonical" href="https://www.eclipse.org/che/docs/che-7/administration-guide/tracing-che/">
     <meta name="keywords" content="administration-guide, tracing-che">
     <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="../../end-user-guide/navigating-che/">Navigating Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/navigating-che-using-the-dashboard/">Navigating Che: dashboard</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/importing-certificates-to-browsers/">Importing certificates to browsers</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/version-control/">Version Control</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/che-theia-troubleshooting/">Che-Theia Troubleshooting</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/workspaces-overview/">Using developer workspaces</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/configuring-a-workspace-with-dashboard/">Configuring a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/running-a-workspace-with-dashboard/">Running a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/remotely-accessing-workspaces/">Remotely accessing workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/authoring-devfiles/">Authoring devfiles</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/authoring-devfiles-version-1/">Authoring devfiles version 1</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/customizing-developer-environments/">Customizing developer environments</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/support-for-jetbrains-ides/">JetBrains IDEs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/using-jetbrains-webstorm/">Using WebStorm</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/support-for-theia-based-ides/">Theia-based IDEs</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/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="../../end-user-guide/using-maven-artifact-repositories/">Using Maven artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-gradle-artifact-repositories/">Using Gradle artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-python-artifact-repositories/">Using Python artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-go-artifact-repositories/">Using Go artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-nuget-artifact-repositories/">Using NuGet artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/troubleshooting-che/">Troubleshooting Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/viewing-che-workspaces-logs/">Viewing Che workspaces logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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="../../end-user-guide/troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/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 or a ConfigMap as a file or an environment variable into a Eclipse&#160;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="../che-architecture-overview/">Che architecture</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../che-workspace-controller/">Che workspace controller</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../che-workspaces-architecture/">Che workspaces architecture</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../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="../customizing-the-registries/">Customizing the registries</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../building-custom-registry-images/">Building custom registry images</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../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="../retrieving-che-logs/">Retrieving Che logs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../configuring-server-logging/">Configuring server logging</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-kubernetes-events/">Accessing Kubernetes events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-operator-events/">Viewing the Operator events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-che-server-logs/">Viewing Che server logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-external-service-logs/">Viewing external service logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-plug-in-broker-logs/">Viewing Plug-in broker logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../collecting-logs-using-chectl/">Collecting logs using chectl</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../monitoring-che/">Monitoring Che</a>
   </li>
   <li class="nav-item is-current-page" data-depth="1">
     <a class="nav-link" href="./">Tracing Che</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../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="../external-database-setup/">External database setup</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../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="../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="../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="../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="../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="../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="../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="../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="../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="../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="../authenticating-users/">Authenticating users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../authorizing-users/">Authorizing users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../configuring-authorization/">Configuring authorization</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../configuring-openshift-oauth/">Configuring OpenShift OAuth</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../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.adoc</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>Administration Guide</li>
     <li><a href="./">Tracing Che</a></li>
   </ul>
 </nav>
   <div class="edit-this-page"><a href="https://github.com/eclipse/che-docs/edit/master/modules/administration-guide/pages/tracing-che.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">Tracing Che</h1>
 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>Tracing helps gather timing data to troubleshoot latency problems in microservice architectures and helps to understand a complete transaction or workflow as it propagates through a distributed system. Every transaction may reflect performance anomalies in an early phase when new services are being introduced by independent teams.</p>
 </div>
 <div class="paragraph">
 <p>Tracing the Che application may help analyze the execution of various operations, such as workspace creations, workspace startup, breaking down the duration of sub-operations executions, helping finding bottlenecks and improve the overall state of the platform.</p>
 </div>
 <div class="paragraph">
 <p>Tracers live in applications. They record timing and metadata about operations that take place. They often instrument libraries, so that their use is indiscernible to users. For example, an instrumented web server records when it received a request and when it sent a response. The trace data collected is called a <strong>span</strong>. A span has a context that contains information such as trace and span identifiers and other kinds of data that can be propagated down the line.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_tracing_api"><a class="anchor" href="#_tracing_api"></a>Tracing API</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Che utilizes <a href="https://opentracing.io/">OpenTracing API</a> - a vendor-neutral framework for instrumentation. This means that if a developer wants to try a different tracing back end, then rather than repeating the whole instrumentation process for the new distributed tracing system, the developer can simply change the configuration of the tracer back end.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_tracing_back_end"><a class="anchor" href="#_tracing_back_end"></a>Tracing back end</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>By default, Che uses Jaeger as the tracing back end. Jaeger was inspired by Dapper and OpenZipkin, and it is a distributed tracing system released as open source by Uber Technologies. Jaeger extends a more complex architecture for a larger scale of requests and performance.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="installing-the-jaeger-tracing-tool_che"><a class="anchor" href="#installing-the-jaeger-tracing-tool_che"></a>Installing the Jaeger tracing tool</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The following sections describe the installation methods for the Jaeger tracing tool. Jaeger can then be used for gathering metrics in Che.</p>
 </div>
 <div class="paragraph">
 <p>Installation methods available:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p><a href="#installing-jaeger-using-operatorhub-on-openshift-4_che">Installing Jaeger using OperatorHub on OpenShift 4</a></p>
 </li>
 <li>
 <p><a href="#installing-jaeger-using-cli-on-openshift-4_che">Installing Jaeger using CLI on OpenShift 4</a></p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>For tracing a Che instance using Jaeger, version 1.12.0 or above is required. For additional information about Jaeger, see the <a href="https://www.jaegertracing.io/docs/latest/">Jaeger website</a>.</p>
 </div>
 <div class="sect2">
 <h3 id="installing-jaeger-using-operatorhub-on-openshift-4_che"><a class="anchor" href="#installing-jaeger-using-operatorhub-on-openshift-4_che"></a>Installing Jaeger using OperatorHub on OpenShift 4</h3>
 <div class="paragraph">
 <p>This section provide information about using Jaeger tracing tool for testing an evaluation purposes in production.</p>
 </div>
 <div class="paragraph">
 <p>To install the Jaeger tracing tool from the OperatorHub interface in OpenShift&#160;Container&#160;Platform, follow the instructions below.</p>
 </div>
 <div class="ulist">
 <div class="title">Prerequisites</div>
 <ul>
 <li>
 <p>The user is logged in to the OpenShift&#160;Container&#160;Platform Web Console.</p>
 </li>
 <li>
 <p>A Che instance is available in a namespace.</p>
 </li>
 </ul>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
 <ol class="arabic">
 <li>
 <p>Open the OpenShift&#160;Container&#160;Platform console.</p>
 </li>
 <li>
 <p>From the left menu of the main OpenShift&#160;Container&#160;Platform screen, navigate to <strong>Operators → OperatorHub</strong>.</p>
 </li>
 <li>
 <p>In the <strong>Search by keyword</strong> search bar, type <code>Jaeger Operator</code>.</p>
 </li>
 <li>
 <p>Click the <code>Jaeger Operator</code> tile.</p>
 </li>
 <li>
 <p>Click the <b class="button">Install</b> button in the <code>Jaeger Operator</code> pop-up window.</p>
 </li>
 <li>
 <p>Select the installation method: <code>A specific namespace on the cluster</code> where the Che is deployed and leave the rest in its default values.</p>
 </li>
 <li>
 <p>Click the <strong>Subscribe</strong> button.</p>
 </li>
 <li>
 <p>From the left menu of the main OpenShift&#160;Container&#160;Platform screen, navigate to the <strong>Operators → Installed Operators</strong> section.</p>
 </li>
 <li>
 <p>Eclipse&#160;Che is displayed as an Installed Operator, as indicated by the <strong>InstallSucceeded</strong> status.</p>
 </li>
 <li>
 <p>Click the <strong>Jaeger Operator</strong> name in the list of installed Operators.</p>
 </li>
 <li>
 <p>Navigate to the <strong>Overview</strong> tab.</p>
 </li>
 <li>
 <p>In the Conditions sections at the bottom of the page, wait for this message: <code>install strategy completed with no errors</code>.</p>
 </li>
 <li>
 <p><code>Jaeger Operator</code> and additional <code>Elasticsearch Operator</code> is installed.</p>
 </li>
 <li>
 <p>Navigate to the <strong>Operators → Installed Operators</strong> section.</p>
 </li>
 <li>
 <p>Click <strong>Jaeger Operator</strong>  in the list of installed Operators.</p>
 </li>
 <li>
 <p>The <strong>Jaeger Cluster</strong> page is displayed.</p>
 </li>
 <li>
 <p>In the lower left corner of the window, click <strong>Create Instance</strong></p>
 </li>
 <li>
 <p>Click <strong>Save</strong>.</p>
 </li>
 <li>
 <p>OpenShift creates the Jaeger cluster <code>jaeger-all-in-one-inmemory</code>.</p>
 </li>
 <li>
 <p>Follow the steps in <a href="#enabling-metrics-collection_che">Enabling metrics collection</a> to finish the procedure.</p>
 </li>
 </ol>
 </div>
 </div>
 <div class="sect2">
 <h3 id="installing-jaeger-using-cli-on-openshift-4_che"><a class="anchor" href="#installing-jaeger-using-cli-on-openshift-4_che"></a>Installing Jaeger using CLI on OpenShift 4</h3>
 <div class="paragraph">
 <p>This section provide information about using Jaeger tracing tool for testing an evaluation purposes.</p>
 </div>
 <div class="paragraph">
 <p>To install the Jaeger tracing tool from a Che project in OpenShift&#160;Container&#160;Platform, follow the instructions in this section.</p>
 </div>
 <div class="ulist">
 <div class="title">Prerequisites</div>
 <ul>
 <li>
 <p>The user is logged in to the OpenShift&#160;Container&#160;Platform web console.</p>
 </li>
 <li>
 <p>A instance of Che in an OpenShift&#160;Container&#160;Platform cluster.</p>
 </li>
 </ul>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
 <ol class="arabic">
 <li>
 <p>In the Che installation namespace of the OpenShift&#160;Container&#160;Platform cluster,  use the <code>oc</code> client to create a new application for the Jaeger deployment.</p>
 <div class="listingblock">
 <div class="content">
 <pre>$ oc new-app -f / ${CHE_LOCAL_GIT_REPO}/deploy/openshift/templates/jaeger-all-in-one-template.yml:

 --&gt; Deploying template "<em>&lt;project_name&gt;</em>/jaeger-template-all-in-one" for "/home/user/che-projects/che/deploy/openshift/templates/jaeger-all-in-one-template.yml" to project <em>&lt;project_name&gt;</em>

      Jaeger (all-in-one)
      ---------
      Jaeger Distributed Tracing Server (all-in-one)

      * With parameters:
         * Jaeger Service Name=jaeger
         * Image version=latest
         * Jaeger Zipkin Service Name=zipkin

 --&gt; Creating resources ...
     deployment.apps "jaeger" created
     service "jaeger-query" created
     service "jaeger-collector" created
     service "jaeger-agent" created
     service "zipkin" created
     route.route.openshift.io "jaeger-query" created
 --&gt; Success
     Access your application using the route: 'jaeger-query-<em>&lt;project_name&gt;</em>.apps.ci-ln-whx0352-d5d6b.origin-ci-int-aws.dev.rhcloud.com'
     Run 'oc status' to view your app.</pre>
 </div>
 </div>
 </li>
 <li>
 <p>Using the <strong>Workloads &#8594; Deployments</strong> from the left menu of main OpenShift&#160;Container&#160;Platform screen, monitor the Jaeger deployment until it finishes successfully.</p>
 </li>
 <li>
 <p>Select <strong>Networking &#8594; Routes</strong> from the left menu of the main OpenShift&#160;Container&#160;Platform screen, and click the URL link to access the Jaeger dashboard.</p>
 </li>
 <li>
 <p>Follow the steps in <a href="#enabling-metrics-collection_che">Enabling metrics collection</a> to finish the procedure.</p>
 </li>
 </ol>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="enabling-metrics-collection_che"><a class="anchor" href="#enabling-metrics-collection_che"></a>Enabling metrics collection</h2>
 <div class="sectionbody">
 <div class="ulist">
 <div class="title">Prerequisites</div>
 <ul>
 <li>
 <p>Installed Jaeger v1.12.0 or above. See instructions at <a href="#installing-the-jaeger-tracing-tool_che">Installing the Jaeger tracing tool</a></p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <div class="title">Procedure</div>
 <p>For Jaeger tracing to work, enable the following environment variables in your Che deployment:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash"># Activating Che tracing modules
 CHE_TRACING_ENABLED=true

 # Following variables are the basic Jaeger client library configuration.
 JAEGER_ENDPOINT="http://jaeger-collector:14268/api/traces"

 # Service name
 JAEGER_SERVICE_NAME="che-server"

 # URL to remote sampler
 JAEGER_SAMPLER_MANAGER_HOST_PORT="jaeger:5778"

 # Type and param of sampler (constant sampler for all traces)
 JAEGER_SAMPLER_TYPE="const"
 JAEGER_SAMPLER_PARAM="1"

 # Maximum queue size of reporter
 JAEGER_REPORTER_MAX_QUEUE_SIZE="10000"</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>To enable the following environment variables:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>In the  <code>yaml</code> source code of the Che deployment, add the following configuration variables under <code>spec.server.customCheProperties</code>.</p>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">customCheProperties:
       CHE_TRACING_ENABLED: 'true'
       JAEGER_SAMPLER_TYPE: const
       DEFAULT_JAEGER_REPORTER_MAX_QUEUE_SIZE: '10000'
       JAEGER_SERVICE_NAME: che-server
       JAEGER_ENDPOINT: 'http://jaeger-collector:14268/api/traces'
       JAEGER_SAMPLER_MANAGER_HOST_PORT: 'jaeger:5778'
       JAEGER_SAMPLER_PARAM: '1'</code></pre>
 </div>
 </div>
 </li>
 <li>
 <p>Edit the <code>JAEGER_ENDPOINT</code> value to match the name of the Jaeger collector service in your deployment.</p>
 <div class="paragraph">
 <p>From the left menu of the main OpenShift&#160;Container&#160;Platform screen, obtain the value of JAEGER_ENDPOINT by navigation to <strong>Networking &#8594; Services</strong>. Alternatively, execute the following <code>oc</code> command:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre>$ oc get services</pre>
 </div>
 </div>
 <div class="paragraph">
 <p>The requested value is included in the service name that contains the <code>collector</code> string.</p>
 </div>
 </li>
 </ol>
 </div>
 <div class="ulist">
 <div class="title">Additional resources</div>
 <ul>
 <li>
 <p>For additional information about custom environment properties and how to define them in CheCluster Custom Resource, see <a href="../../installation-guide/advanced-configuration-options-for-the-che-server-component/" class="page">Advanced configuration options for the Che server component</a>.</p>
 </li>
 <li>
 <p>For custom configuration of Jaeger, see the list of <a href="https://github.com/jaegertracing/jaeger-client-go#user-content-environment-variables">Jaeger client environment variables</a>.</p>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="viewing-che-traces-in-jaeger-ui_che"><a class="anchor" href="#viewing-che-traces-in-jaeger-ui_che"></a>Viewing Che traces in Jaeger UI</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>This section demonstrates how to use the Jaeger UI to overview traces of Che operations.</p>
 </div>
 <div class="paragraph">
 <div class="title">Procedure</div>
 <p>In this example, the Che instance has been running for some time and one workspace start has occurred.</p>
 </div>
 <div class="paragraph">
 <p>To inspect the trace of the workspace start:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>In the <strong>Search</strong> panel on the left, filter spans by the operation name (span name), tags, or time and duration.</p>
 <div class="imageblock">
 <div class="content">
 <a class="image" href="../_images/tracing/trace-search.png"><img src="../_images/tracing/trace-search.png" alt="trace search"></a>
 </div>
 <div class="title">Figure 1. Using Jaeger UI to trace Che</div>
 </div>
 </li>
 <li>
 <p>Select the trace to expand it and show the tree of nested spans and additional information about the highlighted span, such as tags or durations.</p>
 <div class="imageblock">
 <div class="content">
 <a class="image" href="../_images/tracing/trace-tree-expanded.png"><img src="../_images/tracing/trace-tree-expanded.png" alt="trace tree expanded"></a>
 </div>
 <div class="title">Figure 2. Expanded tracing tree</div>
 </div>
 </li>
 </ol>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="che-tracing-codebase-overview-and-extension-guide_che"><a class="anchor" href="#che-tracing-codebase-overview-and-extension-guide_che"></a>Che tracing codebase overview and extension guide</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The core of the tracing implementation for Che is in the <code>che-core-tracing-core</code> and <code>che-core-tracing-web</code> modules.</p>
 </div>
 <div class="paragraph">
 <p>All HTTP requests to the tracing API have their own trace. This is done by <code>TracingFilter</code> from the <a href="https://github.com/opentracing-contrib/java-web-servlet-filter">OpenTracing library</a>, which is bound for the whole server application. Adding a <code>@Traced</code> annotation to methods causes the <code>TracingInterceptor</code> to add tracing spans for them.</p>
 </div>
 <div class="sect2">
 <h3 id="_tagging"><a class="anchor" href="#_tagging"></a>Tagging</h3>
 <div class="paragraph">
 <p>Spans may contain standard tags, such as operation name, span origin, error, and other tags that may help users with querying and filtering spans. Workspace-related operations (such as starting or stopping workspaces) have additional tags, including <code>userId</code>, <code>workspaceID</code>, and <code>stackId</code>. Spans created by <code>TracingFilter</code> also have an HTTP status code tag.</p>
 </div>
 <div class="paragraph">
 <p>Declaring tags in a traced method is done statically by setting fields from the <code>TracingTags</code> class:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">TracingTags.WORKSPACE_ID.set(workspace.getId());</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p><code>TracingTags</code> is a class where all commonly used tags are declared, as respective <code>AnnotationAware</code> tag implementations.</p>
 </div>
 <div class="paragraph">
 <div class="title">Additional resources</div>
 <p>For more information about how to use Jaeger UI, visit Jaeger documentation: <a href="https://www.jaegertracing.io/docs/1.12/getting-started/">Jaeger Getting Started Guide</a>.</p>
 </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>