diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee02cc5 --- /dev/null +++ b/README.md @@ -0,0 +1,154 @@ +<!-- markdownlint-disable-next-line --> +# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OTel logo" width="45"> OpenTelemetry Demo + +[](https://cloud-native.slack.com/archives/C03B4CWV4DA) +[](https://github.com/open-telemetry/opentelemetry-demo/releases) +[](https://github.com/open-telemetry/opentelemetry-demo/graphs/commit-activity) +[](https://hub.docker.com/r/otel/demo) +[](https://github.com/open-telemetry/opentelemetry-demo/blob/main/LICENSE) +[](https://github.com/open-telemetry/opentelemetry-demo/actions/workflows/run-integration-tests.yml) +[](https://artifacthub.io/packages/helm/opentelemetry-helm/opentelemetry-demo) +[](https://www.bestpractices.dev/en/projects/9247) + +## 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](https://github.com/open-telemetry/opentelemetry-demo/blob/main/CHANGELOG.md), +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](./CONTRIBUTING.md). + +If you'd like to extend this demo or maintain a fork of it, read our +[fork guidance](https://opentelemetry.io/docs/demo/forking/). + +## Quick start + +You can be up and running with the demo in a few minutes. Check out the docs for +your preferred deployment method: + +- [Docker](https://opentelemetry.io/docs/demo/docker_deployment/) +- [Kubernetes](https://opentelemetry.io/docs/demo/kubernetes_deployment/) + +## Documentation + +For detailed documentation, see [Demo Documentation][docs]. If you're curious +about a specific feature, the [docs landing page][docs] 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] | [Parseable] | +| [Apache Doris] | [Google Cloud] | [Sentry] | +| [AppDynamics] | [Grafana Labs] | [ServiceNow Cloud Observability] | +| [Aspecto] | [Guance] | [SigNoz] | +| [Axiom] | [Honeycomb.io] | [Splunk] | +| [Axoflow] | [Instana] | [Sumo Logic] | +| [Azure Data Explorer] | [Kloudfuse] | [TelemetryHub] | +| [Causely] | [Last9] | [Teletrace] | +| [ClickStack] | [Liatrio] | [Tinybird] | +| [Coralogix] | [Logz.io] | [Tracetest] | +| [Dash0] | [New Relic] | [Uptrace] | +| [Datadog] | [OpenSearch] | [VictoriaMetrics] | +| [Dynatrace] | [Oracle] | | + +## Contributing + +To get involved with the project see our [CONTRIBUTING](CONTRIBUTING.md) +documentation. Our [SIG Calls](CONTRIBUTING.md#join-a-sig-call) are every other +Wednesday at 8:30 AM PST and anyone is welcome. + +### Maintainers + +- [Juliano Costa](https://github.com/julianocosta89), Datadog +- [Mikko Viitanen](https://github.com/mviitane), Dynatrace +- [Pierre Tessier](https://github.com/puckpuck), Honeycomb +- [Roger Coll](https://github.com/rogercoll), Elastic + +For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer). + +### Approvers + +- [Cedric Ziel](https://github.com/cedricziel), Grafana Labs +- [Shenoy Pratik](https://github.com/ps48), AWS OpenSearch + +For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver). + +### Emeritus + +- [Austin Parker](https://github.com/austinlparker) +- [Carter Socha](https://github.com/cartersocha) +- [Michael Maxwell](https://github.com/mic-max) +- [Morgan McLean](https://github.com/mtwo) +- [Penghan Wang](https://github.com/wph95) +- [Reiley Yang](https://github.com/reyang) +- [Ziqi Zhao](https://github.com/fatsheep9146) + +For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). + +### Thanks to all the people who have contributed + +[](https://github.com/open-telemetry/opentelemetry-demo/graphs/contributors) + +[docs]: https://opentelemetry.io/docs/demo/ + +<!-- Links for Demos featuring the Astronomy Shop section --> + +[AlibabaCloud LogService]: https://github.com/aliyun-sls/opentelemetry-demo +[AppDynamics]: https://community.splunk.com/t5/AppDynamics-Knowledge-Base/How-to-observe-Kubernetes-deployment-of-OpenTelemetry-demo-app/ta-p/741454 +[Apache Doris]: https://github.com/apache/doris-opentelemetry-demo +[Aspecto]: https://github.com/aspecto-io/opentelemetry-demo +[Axiom]: https://play.axiom.co/axiom-play-qf1k/dashboards/otel.traces.otel-demo-traces +[Axoflow]: https://axoflow.com/opentelemetry-support-in-more-detail-in-axosyslog-and-syslog-ng/ +[Azure Data Explorer]: https://github.com/Azure/Azure-kusto-opentelemetry-demo +[Causely]: https://github.com/causely-oss/otel-demo +[ClickStack]: https://github.com/ClickHouse/opentelemetry-demo +[Coralogix]: https://coralogix.com/blog/configure-otel-demo-send-telemetry-data-coralogix +[Dash0]: https://github.com/dash0hq/opentelemetry-demo +[Datadog]: https://docs.datadoghq.com/opentelemetry/guide/otel_demo_to_datadog +[Dynatrace]: https://www.dynatrace.com/news/blog/opentelemetry-demo-application-with-dynatrace/ +[Elastic]: https://github.com/elastic/opentelemetry-demo +[Google Cloud]: https://github.com/GoogleCloudPlatform/opentelemetry-demo +[Grafana Labs]: https://github.com/grafana/opentelemetry-demo +[Guance]: https://github.com/GuanceCloud/opentelemetry-demo +[Honeycomb.io]: https://github.com/honeycombio/opentelemetry-demo +[Instana]: https://github.com/instana/opentelemetry-demo +[Kloudfuse]: https://github.com/kloudfuse/opentelemetry-demo +[Last9]: https://last9.io/docs/integrations-opentelemetry-demo/ +[Liatrio]: https://github.com/liatrio/opentelemetry-demo +[Logz.io]: https://logz.io/learn/how-to-run-opentelemetry-demo-with-logz-io/ +[New Relic]: https://github.com/newrelic/opentelemetry-demo +[OpenSearch]: https://github.com/opensearch-project/opentelemetry-demo +[Oracle]: https://github.com/oracle-quickstart/oci-o11y-solutions/blob/main/knowledge-content/opentelemetry-demo +[Parseable]: https://www.parseable.com/blog/open-telemetry-demo-with-parseable-a-complete-observability-setup +[Sentry]: https://github.com/getsentry/opentelemetry-demo +[ServiceNow Cloud Observability]: https://docs.lightstep.com/otel/quick-start-operator#send-data-from-the-opentelemetry-demo +[SigNoz]: https://signoz.io/blog/opentelemetry-demo/ +[Splunk]: https://github.com/signalfx/opentelemetry-demo +[Sumo Logic]: https://www.sumologic.com/blog/common-opentelemetry-demo-application/ +[TelemetryHub]: https://github.com/TelemetryHub/opentelemetry-demo/tree/telemetryhub-backend +[Teletrace]: https://github.com/teletrace/opentelemetry-demo +[Tinybird]: https://github.com/tinybirdco/opentelemetry-demo +[Tracetest]: https://github.com/kubeshop/opentelemetry-demo +[Uptrace]: https://github.com/uptrace/uptrace/tree/master/example/opentelemetry-demo +[VictoriaMetrics]: https://github.com/VictoriaMetrics-Community/opentelemetry-demo |