Welcome to New Relic’s fork of the OpenTelemetry Astronomy Shop! This app is a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment. To view the original repo README, scroll down or click this link.
After you follow our quick start instructions to deploy the app, check out how to navigate the OTLP data in your New Relic account!
Please note the following modifications to our fork:
- The .env file contains New Relic-specific environment variables so you can quickly ship the data to your account
- recommendationservice has been instrumented with the New Relic Python APM agent to demonstrate interoperability between our language agents and OpenTelemetry instrumentation
Get started quickly by running the app according to your deployment method preference:
Requirements: A New Relic account – sign up for a free account if you need one.
The Demo comes with a number of problem scenarios that you can enable via a feature flag; please note that some of these are currently still under testing on our end.
We are working on tutorials to show you how to troubleshoot these scenarios in New Relic.
In the meantime, check out our documentation to learn how to navigate your OpenTelemetry traces, metrics, and logs in New Relic.
Similar to how the Astronomy Shop is under active development, we are also actively developing and maintaining our fork. Here are a few things we have are working on, or have planned for the near future:
- Demo scenario feature flags are in testing
- Troubleshooting tutorials for each demo scenario
- Support for OTel-sourced Kubernetes infrastructure metrics in New Relic
- Add a feature flag to enable NR instrumentation for recommendationservice when using Docker quick start method
Have a suggestion, or running into problems with our fork? Please let us know by opening an issue!
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:
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 Monday at 8:30 AM PST and anyone is welcome.
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: