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:
This is a fork of the original opentelemetry-demo. It contains the following modifications:
- Contains otel-col changes for exporting logs to loki and/or Coralogix.
- Uses alertmanager to fire alerts based on Prometheus. Alert manager is configured
- Contains some UI changes
- Clone this fork
- Run
make start.
That's it. Now all the microservices should be up. It's an e-commerce app so you can navigate to http://localhost:8080/ and play with the UI.
In order to export logs to Coralogix, you need to change the root .env file.
Go to the root .env and modify the following vars:
CORALOGIX_DOMAIN. For example: eu2.coralogix.comCORALOGIX_PRIVATE_KEY. This should be your "Send Your Data" key. Go to Data Flow -> API Keys -> Send Your Data to generate a new key.
CORALOGIX_APP_NAMEandCORALOGIX_SUBSYS_NAMEcan stay the same.
For more information, see this official blog post: https://coralogix.com/blog/configure-otel-demo-send-telemetry-data-coralogix/
If you want to send your Grafana alerts to Opsgenie to trigger incidents, you need to change the opsgenie.yaml file.
Go to opsgenie.yaml and change apiKey field. This should be a Opsgenie API key.
To generate an API key, go to your Opsgenie dashboard. Click Settings and go to Integrations. In the integrations screen, click "Add integration". Search for "API" and select it. Afterwards, click "Enable integration". That's it. Now you should see your newly created API key.
For more information, checout our docs: https://docs.merlinn.co/Integrations/Opsgenie
In order to connect alertmanager to Slack, you can generate a webhook url and insert it into alertmanager-config.yaml.
In order to sync the fork, follow these steps:
- In your local folder, checkout
upstream/main:
git checkout upstream/main- Pull the latest changes:
git pull upstream main- Rebase our main into the local upstream branch and solve conflicts (make sure to do
git rebase --continuein between conflicts.)
git rebase main- Checkout our local main:
git checkout main- Rebase local upstream into main
git rebase upstream/main- Solve all the conflicts (similar to step 3, with
git rebase --continue).