Skip to main content

OpenTelemetry Astronomy Shop Demo

The OpenTelemetry Demo is an example application published by the OpenTelemtry CNCF project. It implements an Astronomy shop in a set of microservices in different languages with OpenTelemetry enabled, intended to be used as an example of OpenTelemetry instrumentation and observability. The Tracetest team has made several key contributions to this project, including providing a full suite of end to end tests.

info

Want to run tests against the OpenTelemetry Astronomy Shop without installing it? Click the link below and we will add you to our tracetest-demo organization and give you access to the opentelemetry-demo org as an engineer. You can run and create your own tests!

👉 Access the shared demo, here.

We will provide a full recipe below for running the full demo as well as running the associated Tracetests via Docker. Here are other references you may find useful:

info

Tracetest is part of the official testing harness in the latest version of the OpenTelemetry Demo. Read more in the OpenTelemetry docs, here.

Or, check out the hands-on workshop on YouTube!

Running the OpenTelemetry Astronomy Shop Demo in Docker

Prerequisites

  • Docker
  • Docker Compose v2.0.0+
  • 4 GB of RAM for the application

Get and run the demo

  1. Clone the Demo repository:

    git clone https://github.com/open-telemetry/opentelemetry-demo.git
  2. Change to the demo folder:

    cd opentelemetry-demo/
  3. Run docker compose1 to start the demo:

    docker compose up --no-build

    Notes:

    • The --no-build flag is used to fetch released docker images from ghcr instead of building from source. Removing the --no-build command line option will rebuild all images from source. It may take more than 20 minutes to build if the flag is omitted.
    • If you're running on Apple Silicon, run docker compose build1 in order to create local images vs. pulling them from the repository.

Verify the web store and Telemetry

Once the images are built and containers are started you can access:

Running Tracetests

The Tracetest tests for the OpenTelemetry Demo can be found in the official repo here:

To run the entire Test Suite of trace-based tests, run the command:

make run-tracetesting
#or
docker compose run traceBasedTests

To run tests for specific services, pass the name of the service as a parameter (using the folder names located here:

make run-tracetesting SERVICES_TO_TEST="service-1 service-2 ..."
#or
docker compose run traceBasedTests "service-1 service-2 ..."

For instance, if you need to run the tests for ad-service and payment-service, you can run them with:

make run-tracetesting SERVICES_TO_TEST="ad-service payment-service"

Tracetest will be started on http://localhost:11633 as part of running these tests and you can view any of the tests, Test Suites, prior runs, or create and run your own tests. It is a great testbed to explore Tracetest!

Use Cases

System Architecture

This demonstration environment consists of a series of microservices, handling each aspect of the store, such as Product Catalog, Payment, Currency, etc.

A detailed description of these services can be seen here and the architecture diagrams can be seen here.