OpenTelemetry Demo

Welcome to the OpenTelemetry Astronomy Shop Demo

This repository contains the OpenTelemetry Astronomy Shop, a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment.

Our goals are threefold:

• Provide a realistic example of a distributed system that can be used to demonstrate OpenTelemetry instrumentation and observability.
• Build a base for vendors, tooling authors, and others to extend and demonstrate their OpenTelemetry integrations.
• Create a living example for OpenTelemetry contributors to use for testing new versions of the API, SDK, and other components or enhancements.

We've already made huge progress, and development is ongoing. We hope to represent the full feature set of OpenTelemetry across its languages in the future.

If you'd like to help (which we would love), check out our contributing guidance.

If you'd like to extend this demo or maintain a fork of it, read our fork guidance.

Quick start

Prerequisites

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

Running this demo

git clone https://github.com/teletrace/opentelemetry-demo.git
cd opentelemetry-demo

docker compose up --no-build

Services

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

• Webstore: http://localhost:8080/
• Grafana: http://localhost:8080/grafana/
• Feature Flags UI: http://localhost:8080/feature/
• Load Generator UI: http://localhost:8080/loadgen/
• Jaeger UI: http://localhost:8080/jaeger/ui/
• Teletrace UI: http://localhost:18080/

Documentation

For detailed documentation, see Demo Documentation. If you're curious about a specific feature, the docs landing page can point you in the right direction.

Demos featuring the Astronomy Shop

We welcome any vendor to fork the project to demonstrate their services and adding a link below. The community is committed to maintaining the project and keeping it up to date for you.

AlibabaCloud LogService	Grafana Labs	Sentry
AppDynamics	Helios	Splunk
Aspecto	Honeycomb.io	Sumo Logic
Azure Data Explorer	Instana	TelemetryHub
Coralogix	Kloudfuse	Teletrace
Datadog	Lightstep	Uptrace
Dynatrace	New Relic
Elastic	OpenSearch

Contributing

To get involved with the project see our CONTRIBUTING documentation. Our SIG Calls are Mondays at 8:15 AM PST and anyone is welcome.

Project leadership

Maintainers (@open-telemetry/demo-maintainers):

• Austin Parker, Lightstep
• Carter Socha, Lightstep
• Juliano Costa, Dynatrace
• Pierre Tessier, Honeycomb

Approvers (@open-telemetry/demo-approvers):

• Mikko Viitanen, Dynatrace
• Penghan Wang, AppDynamics
• Reiley Yang, Microsoft
• Ziqi Zhao, Alibaba

Emeritus:

• Michael Maxwell
• Morgan McLean

Thanks to all the people who have contributed