Skip to main content

Installing Tracetest Core

This page showcases getting started with Tracetest Core by using the Tracetest CLI, Docker, or Kubernetes.

This simple installation includes a demo app called Pokeshop that will be installed alongside Tracetest Core. It shows how to configure OpenTelemetry and Tracetest Core and the architecture of the Pokeshop sample app.

Install the Tracetest CLI

brew install kubeshop/tracetest/tracetest
Want more info?

Read the CLI installation reference here.

Install the Tracetest Server

Tracetest Core runs as a standalone container. It runs a Server and exposes a Web UI on port 11633.

You have three options to install Tracetest Server:

tracetest server install
How do you want to run Tracetest? [type to search]:
> Using Docker Compose
Using Kubernetes

Choose to install Tracetest with the OpenTelemetry Collector and the Pokeshop sample app.

Expected output:
Do you have OpenTelemetry based tracing already set up, or would you like us to install a demo tracing environment and app? [type to search]: 
I have a tracing environment already. - Just install Tracetest.
> Just learning tracing! Install Tracetest, OpenTelemetry Collector and the sample app.

Choosing any option, this installer will create a tracetest directory in the current directory and add a docker-compose.yaml file to it.

  • If you choose the first option, the docker-compose.yaml will have only Tracetest Core and its dependencies.
  • By choosing the second option, a sample app called Pokeshop will be installed with Tracetest Core, allowing you to create sample tests right away!
Click to view Pokeshop Sample App Architecture

Here's the Architecture of the Pokeshop Sample App:

  • an API that serves client requests,
  • a Worker who deals with background processes.

The communication between the API and Worker is made using a RabbitMQ queue, and both services emit telemetry data to OpenTelemetry Collector and communicate with a Postgres database.

Tracetest triggers tests against the Node.js API.

Start Docker Compose from the directory where you ran tracetest server install.

docker compose -f tracetest/docker-compose.yaml up -d

This will start the Tracetest Server and expose the Web UI on http://localhost:11633.