The following sections describe the installation methods for the Jaeger tracing tool. Jaeger can then be used for gathering metrics in Che.

Installation methods available:

For tracing a Che instance using Jaeger, version 1.12.0 or above is required. For additional information about Jaeger, see the Jaeger website.

Installing the Jaeger tracing tool for Che on OpenShift 4

To install the Jaeger tracing tool from a Che project in OpenShift Container Platform, follow the instructions below.

Prerequisites

  • The user is logged in to the OpenShift Container Platform web console.

  • Che is installed in a OpenShift Container Platform cluster.

Procedure

  1. In the Che installation namespace of the OpenShift Container Platform cluster, use the oc client to create a new application for the Jaeger deployment.

    $ oc new-app -f / ${CHE_LOCAL_GIT_REPO}/deploy/openshift/templates/jaeger-all-in-one-template.yml:

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

     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

--> 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
--> Success
    Access your application using the route: 'jaeger-query-<project_name>.apps.ci-ln-whx0352-d5d6b.origin-ci-int-aws.dev.rhcloud.com'
    Run 'oc status' to view your app.

  2. Using the Workloads → Deployments from the left menu of main OpenShift Container Platform screen, monitor the Jaeger deployment until it finishes successfully.

  3. Select Networking → Routes from the left menu of the main OpenShift Container Platform screen, and click the URL link to access the Jaeger dashboard.

  4. Follow the steps in Enabling Che metrics collections to finish the procedure.

Installing Jaeger using OperatorHub on OpenShift 4

To install the Jaeger tracing tool from the OperatorHub interface in OpenShift Container Platform, follow the instructions below.

Prerequisites

  • The user is logged in to the OpenShift Container Platform Web Console.

  • A Che instance is deployed in a namespace.

Procedure

  1. Open the OpenShift Container Platform console.

  2. From the left menu of the main OpenShift Container Platform screen, navigate to Operators → OperatorHub.

  3. In the Search by keyword search bar, type Jaeger Operator.

  4. Click the Jaeger Operator tile.

  5. Click the Install button in the Jaeger Operator pop-up window.

  6. Select the installation method: A specific namespace on the cluster where the Che is deployed and leave the rest in its default values.

  7. Click the Subscribe button.

  8. From the left menu of the main OpenShift Container Platform screen, navigate to the Operators → Installed Operators section.

  9. Eclipse Che is displayed as an Installed Operator, as indicated by the InstallSucceeded status.

  10. Click the Jaeger Operator name in the list of installed operators.

  11. Navigate to the Overview tab.

  12. In the Conditions sections at the bottom of the page, wait for this message: install strategy completed with no errors.

  13. Jaeger Operator and additional Elasticsearch Operator is installed.

  14. Navigate to the Operators → Installed Operators section.

  15. Click Jaeger Operator in the list of installed operators.

  16. The Jaeger Cluster page is displayed.

  17. In the bottom-left corner of the window, click Create Instance

  18. Click Save.

  19. The Jaeger cluster jaeger-all-in-one-inmemory is created.

  20. Follow the steps in Enabling Che metrics collections to finish the procedure.

Installing Jaeger locally using a prebuilt container image

To install the Jaeger tracing tool locally using a prebuilt container image, follow the instructions below.

Prerequisites
Procedure

  1. Start Podman:

    $ sudo service podman start

  2. Install Jaeger using the pre-built container image.

     $ podman run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 9411:9411 \
  jaegertracing/all-in-one:1.15

  3. Navigate to http://localhost:16686 to access the Jaeger UI.

  4. Follow the steps in Enabling Che metrics collections to finish the procedure.