Skip to content

docs(guides): add comprehensive exporter development guide#466

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-456-create-exporter-development-guide
Feb 9, 2026
Merged

docs(guides): add comprehensive exporter development guide#466
kcenon merged 1 commit into
mainfrom
docs/issue-456-create-exporter-development-guide

Conversation

@kcenon

@kcenon kcenon commented Feb 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/guides/EXPORTER_DEVELOPMENT.md covering the complete exporter subsystem
  • Document dual pipeline architecture (metrics + traces) with data flow diagrams
  • Detail all 7 built-in exporters: Prometheus, StatsD, OTLP Metrics, Jaeger, Zipkin, OTLP Traces, OTLP gRPC
  • Document all 3 transport layers (HTTP, gRPC, UDP) with stub/real implementations
  • Include custom exporter implementation guide with full code examples
  • Document OpenTelemetry compatibility layer and integration patterns
  • Provide 4 configuration examples: production multi-backend, local dev, testing stubs, Zipkin custom headers

Resolves #456

Test Plan

  • All 9 referenced source files exist and paths are correct
    • metric_exporters.h, trace_exporters.h, opentelemetry_adapter.h, otlp_grpc_exporter.h
    • http_transport.h, grpc_transport.h, udp_transport.h
    • result_types.h, error_codes.h
  • All code examples compile conceptually against the actual interfaces
    • Verified interface methods match actual source (export_metrics, export_spans, etc.)
    • Factory functions and config structs match implementations
  • Document covers all 6 sections from issue acceptance criteria
    1. Exporter pipeline architecture (Section 2) ✓
    2. All built-in exporters documented (Sections 3-4, 7 exporters) ✓
    3. All 3 transport layers documented (Section 5) ✓
    4. Custom exporter implementation guide (Section 6) ✓
    5. OpenTelemetry integration patterns (Section 7) ✓
    6. At least 3 configuration examples (Section 8, 4 examples) ✓
  • Cross-references to COLLECTOR_DEVELOPMENT.md and ARCHITECTURE.md are valid
  • No broken markdown links or formatting issues

Document the complete exporter subsystem covering:
- Dual pipeline architecture (metrics + traces)
- All 7 built-in exporters with configuration details
- All 3 transport layers (HTTP, gRPC, UDP) with implementations
- Custom exporter implementation guide with examples
- OpenTelemetry compatibility layer and integration patterns
- 4 configuration examples (production, dev, testing, custom)

Resolves #456
@kcenon kcenon merged commit 13b3e46 into main Feb 9, 2026
21 checks passed
@kcenon kcenon deleted the docs/issue-456-create-exporter-development-guide branch February 9, 2026 01:29
kcenon added a commit that referenced this pull request Apr 13, 2026
Document the complete exporter subsystem covering:
- Dual pipeline architecture (metrics + traces)
- All 7 built-in exporters with configuration details
- All 3 transport layers (HTTP, gRPC, UDP) with implementations
- Custom exporter implementation guide with examples
- OpenTelemetry compatibility layer and integration patterns
- 4 configuration examples (production, dev, testing, custom)

Resolves #456
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 exporter development guide

1 participant