feat(examples): add OpenTelemetry distributed tracing example #7117
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This example demonstrates end-to-end distributed tracing across a complete stack incorporating Kafka (using Strimzi images) and Apicurio Registry. Traces flow from message producers through consumers and schema validation operations, allowing visualization of the complete request flow in Jaeger. Components included: - Docker Compose configuration for local deployment - OpenTelemetry Collector configuration - Quarkus producer application with OTel instrumentation - Quarkus consumer application with OTel instrumentation - Kubernetes manifests for K8s deployment with Strimzi - Comprehensive documentation Resolves Apicurio#7109
…acing example - Update Quarkus version from 3.17.7 to 3.27.0 to fix Jandex index version incompatibility - Add quarkus-apicurio-registry-avro extension with exclusions to satisfy Quarkus Kafka processor checks - Replace bundled 2.x serde with project's own 3.x apicurio-registry-avro-serde-kafka - Remove invalid quarkus.otel.instrument.kafka property (Kafka OTel is automatic) - Remove deprecated quarkus.health.extensions.enabled property - Update docker-compose.yml and README.md to remove invalid config references - Add Avro schema to consumer module for Quarkus code generation
The OTEL signal properties (traces/metrics/logs enabled) are build-time properties in Quarkus that cannot be changed at runtime. This fix: - Enables all OTEL signals at build-time (available for use) - Adds quarkus.otel.sdk.disabled=true as runtime default (OTEL off) - Users enable OTEL by setting QUARKUS_OTEL_SDK_DISABLED=false This ensures OTEL can be properly controlled at deployment time. Fixes Apicurio#7147
- Add custom spans using @WithSpan annotation and Tracer API - Add error tracing endpoint with recordException() demonstration - Add baggage propagation for tenant context across services - Implement background consumer with GreetingMessageStore for realistic pattern - Add Kafka partition/offset span attributes - Add consumer statistics endpoint (/consumer/stats) - Add batch consumption endpoints - Add verification scripts (smoke-test.sh, verify-tracing.sh, test-scenarios.sh) - Update README with comprehensive verification section and API reference - Fix K8s registry.yaml to use QUARKUS_OTEL_SDK_DISABLED instead of build-time properties
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Root Cause
Closes #7109 - Users need reference material showing how to configure OTel tracing in a realistic distributed environment with Kafka and Apicurio Registry.
Changes
examples/otel-tracingmodule with:Test plan
mvn clean package -DskipTestsdocker compose up -dcurl -X POST "http://localhost:8081/greetings?name=World"/greetings/batchendpointdocker compose down -vResolves #7109