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.
You can be up and running with the demo in a few minutes. Check out the docs for your preferred deployment method:
This repository contains a realistic microservice demo instrumented with OpenTelemetry. The sections below help you run a minimal local instance and verify observability signals (traces, metrics, logs).
Quick local start (minimal):
cd /path/to/opentelemetry-demo
docker compose -f docker-compose.minimal.yml up --build -dVerify UIs (ports may vary; check docker compose ps):
- Jaeger: http://localhost:16686
- Grafana: http://localhost:55131
- OpenSearch: http://localhost:
For a short guided demo, see DEMO_SCRIPT.md which walks through generating traffic and inspecting a trace in Jaeger, a metric in Grafana, and logs in OpenSearch.
If you plan to modify the demo or stabilize startup on resource‑constrained hosts, inspect docker-compose.yml for service configs (healthchecks, memory limits, JVM options) and the src/ Dockerfiles for service-specific instrumentation.
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.
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.
To get involved with the project see our CONTRIBUTING documentation. Our SIG Calls are every other Wednesday at 8:30 AM PST and anyone is welcome.
- Juliano Costa, Datadog
- Mikko Viitanen, Dynatrace
- Pierre Tessier, Honeycomb
- Roger Coll, Elastic
For more information about the maintainer role, see the community repository.
- Cedric Ziel, Grafana Labs
- Shenoy Pratik, AWS OpenSearch
For more information about the approver role, see the community repository.
For more information about the emeritus role, see the community repository.