/opentelemetry-demo

Primary LanguageTypeScriptApache License 2.0Apache-2.0

OTel logo OpenTelemetry Demo with Google Cloud

Slack Version Commits Downloads License Integration Tests Artifact Hub OpenSSF Best Practices

Welcome to the OpenTelemetry Astronomy Shop Demo with Google Cloud

This repository contains a fork of open-telemetry/opentelemetry-demo, which integrates with Google Cloud Monitoring, Logging, and Trace.

This is not an officially supported Google product.

For details on how to use this with GCP, see README_GCP.md.

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

You can be up and running with the demo in a few minutes. Check out the docs for your preferred deployment method:

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 Elastic New Relic
AppDynamics Google Cloud OpenSearch
Aspecto Grafana Labs Sentry
Axiom Guance ServiceNow Cloud Observability
Axoflow Helios Splunk
Azure Data Explorer Honeycomb.io Sumo Logic
Coralogix Instana TelemetryHub
Dash0 Kloudfuse Teletrace
Datadog Liatrio Tracetest
Dynatrace Logz.io Uptrace

Contributing

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

Project leadership

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

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

Emeritus:

Thanks to all the people who have contributed

contributors