OpenTelemetry Demo Documentation

October 24, 2022 ยท View on GitHub

Welcome to the OpenTelemetry Demo! This folder contains overall documentation for the project, how to install and run it, and some scenarios you can use to view OpenTelemetry in action.

Table of Contents

Running the Demo

Want to deploy the demo and see it in action? Start here.

Language Feature Reference

Want to understand how a particular language's instrumentation works? Start here.

LanguageAuto InstrumentationManual Instrumentation
.NETCart ServiceCart Service
C++
Erlang/ElixirFeature Flag ServiceFeature Flag Service
GoCheckout Service, Product Catalog ServiceCheckout Service, Product Catalog Service
JavaAd ServiceAd Service
JavaScriptFrontendFrontend, Payment Service
PHPQuote ServiceQuote Service
PythonRecommendation ServiceRecommendation Service
RubyEmail ServiceEmail Service
RustShipping ServiceShipping Service

Service Documentation

Specific information about how OpenTelemetry is deployed in each service can be found here:

Scenarios

How can you solve problems with OpenTelemetry? These scenarios walk you through some pre-configured problems and show you how to interpret OpenTelemetry data to solve them.

We'll be adding more scenarios over time.

  • Generate a Product Catalog error for GetProduct requests with product id: OLJCESPC7Z using the Feature Flag service
  • Discover a memory leak and diagnose it using metrics and traces. Read more

Reference

Project reference documentation, like requirements and feature matrices.