Skip to content

Commit

Permalink
README improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
styblope committed May 2, 2024
1 parent be51ffa commit 1ffe829
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions instana/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OTel logo" width="45"> + <img src="https://avatars.githubusercontent.com/u/5128994?s=200&amp;v=4" alt="@instana" width="45" height="45"> OpenTelemetry Demo with Instana

This repository contains a custom fork of the OpenTelemetry Astronomy Shop, a microservice-based demo application, integrated with an Instana backend. The demo shows the native Instana OpenTelemetry data collection, correlation of OpenTelemetry tracing and the underlying monitored infrastructure, or an example of trace continuity between Instana tracing and OpenTelemetry.
This repository contains a custom fork of the [OpenTelemetry Astronomy Shop](https://github.com/open-telemetry/opentelemetry-demo) integrated with an Instana backend. The demo showcases native Instana OpenTelemetry data collection, correlation of OpenTelemetry tracing and underlying monitored infrastructure, or example of trace continuity between Instana-native tracing and OpenTelemetry. Details about the implementation are sumamrized in the [OpenTelemetry Demo with Instana](https://community.ibm.com/community/user/instana/blogs/petr-styblo/2022/12/21/opentelementry-demo?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f) blog article.

To learn more about the demo application please refer to the [upstream README](../README.md) and the [demo documentation](https://opentelemetry.io/docs/demo/) available at the OpenTelemetry project site.
To learn more about the demo application please refer to the [upstream README](../README.md) and the [official demo documentation](https://opentelemetry.io/docs/demo/) available at the OpenTelemetry project site.

### Demo customizations
![otel-demo screenshot](../instana/screenshot.png)

Changes to the upstream demo include:
Custom features include:

- instrumented demo services for Instana infrastructure monitoring (Instana tracing disabled)
- instrumented demo services to enable Instana infrastructure monitoring
- disabled Instana-native tracing in agent and services configuration
- include ready-to-use agent configuration and docker-compose deployment files (in [instana/agent](../instana/agent) folder)
- provide custom Helm [configuration file](../instana/values-instana-agent.yaml) to deploy the demo in Kubernetes (excluding Instana agent deployment)
- ship pre-built custom demo container images
Expand All @@ -26,6 +27,3 @@ If you found a bug, have a suggestion or a question regarding the Instana-specif

## Contributing
Contributions are welcome - feel free to submit a pull request. You may find useful the upstream [CONTRIBUTING](https://github.com/instana/opentelemetry-demo/blob/main/CONTRIBUTING.md) for general general guidance on setting up a development environment or submitting GitHub PRs.

## References
- [OpenTelemetry Demo with Instana community blog post](https://community.ibm.com/community/user/instana/blogs/petr-styblo/2022/12/21/opentelementry-demo?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f)
Binary file added instana/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1ffe829

Please sign in to comment.