Skip to content

docs(guides): add distributed tracing deep dive guide (#461)#471

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-461-create-distributed-tracing-deep-dive-guide
Feb 9, 2026
Merged

docs(guides): add distributed tracing deep dive guide (#461)#471
kcenon merged 1 commit into
mainfrom
docs/issue-461-create-distributed-tracing-deep-dive-guide

Conversation

@kcenon

@kcenon kcenon commented Feb 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Comprehensive guide documenting the distributed tracing subsystem (1,341 lines)
  • Covers tracing architecture, span lifecycle, and parent-child hierarchy
  • Documents W3C Trace Context propagation with inject/extract APIs
  • Documents all 7 export formats across 3 backends (Jaeger, Zipkin, OTLP)
  • Covers OpenTelemetry compatibility layer and adapter
  • Documents HTTP and gRPC transport layers with pluggable implementations
  • Provides 4 production examples: microservice tracing, DB operations, multi-backend export, async messaging

Referenced Source Files

  • include/kcenon/monitoring/tracing/distributed_tracer.h — Public forwarding header
  • src/impl/tracing/distributed_tracer.h — Tracer implementation, span types, context
  • include/kcenon/monitoring/tracing/trace_context.h — Lightweight context
  • include/kcenon/monitoring/context/thread_context.h — Thread-local context
  • include/kcenon/monitoring/exporters/trace_exporters.h — Jaeger, Zipkin, OTLP exporters
  • include/kcenon/monitoring/exporters/opentelemetry_adapter.h — OTel compatibility
  • include/kcenon/monitoring/exporters/http_transport.h — HTTP transport layer
  • include/kcenon/monitoring/exporters/grpc_transport.h — gRPC transport layer

Acceptance Criteria

  • Tracing architecture fully explained
  • Context propagation patterns documented
  • All 4 trace exporters documented with setup (Jaeger, Zipkin, OTLP, Console/stub)
  • Cross-service tracing explained
  • At least 3 complete tracing examples (4 provided)

Test Plan

  • All 8 referenced source files exist in repository (8/8 PASS)
  • Code examples use correct API from source headers
  • Architecture diagram accurately reflects component relationships
  • Cross-references to other guides resolve correctly (3/3 PASS)

Closes #461

Comprehensive guide covering the tracing and export subsystem:
- Tracing architecture with span lifecycle and hierarchy
- W3C Trace Context propagation (inject/extract)
- 7 export formats across 3 backends (Jaeger, Zipkin, OTLP)
- OpenTelemetry compatibility layer and adapter
- HTTP and gRPC transport layers with pluggable implementations
- 4 production examples: microservice tracing, DB ops, multi-backend, async messaging
@kcenon kcenon merged commit 3a713a9 into main Feb 9, 2026
21 checks passed
@kcenon kcenon deleted the docs/issue-461-create-distributed-tracing-deep-dive-guide branch February 9, 2026 06:02
kcenon added a commit that referenced this pull request Apr 13, 2026
Comprehensive guide covering the tracing and export subsystem:
- Tracing architecture with span lifecycle and hierarchy
- W3C Trace Context propagation (inject/extract)
- 7 export formats across 3 backends (Jaeger, Zipkin, OTLP)
- OpenTelemetry compatibility layer and adapter
- HTTP and gRPC transport layers with pluggable implementations
- 4 production examples: microservice tracing, DB ops, multi-backend, async messaging
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] docs: Create distributed tracing deep dive guide

1 participant