OpenTelemetry Demo

Version for ClickStack

We forked the OpenTelemetry demo to provide an example of a instrumented demo application using ClickStack.

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 - Modified for ClickStack

You can be up and running with the demo in a few minutes.

Docker compose

To get started locally, you can deploy it using Docker compose.

docker compose up --build

Access to the OpenTelemetry demo frontend at http://localhost:8080

Logs, traces and metrics are automatically sent to a local ClickHouse deployment. You can access them using HyperDX at http://localhost:9080

Kubernetes

You can find instructions on how to deploy the demo application on Kubernetes here

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.

Contributing

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.

Project leadership

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

• Juliano Costa, Datadog
• Mikko Viitanen, Dynatrace
• Pierre Tessier, Honeycomb

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

• Cedric Ziel Grafana Labs
• Penghan Wang, AppDynamics
• Reiley Yang, Microsoft
• Roger Coll, Elastic
• Ziqi Zhao, Alibaba

Emeritus:

• Austin Parker
• Carter Socha
• Michael Maxwell
• Morgan McLean

Thanks to all the people who have contributed