Skip to content

Update TELEMETRY_ARCHITECTURE.md with Reader/Writer interface split #15

@danieljsinclair

Description

@danieljsinclair

Issue Type

Documentation Update

Severity

Medium - Interface mismatch

Problem Statement

TELEMETRY_ARCHITECTURE.md describes a Reader/Writer interface split for telemetry, but the actual implementation may not match this design.

Documentation Claims

The document describes:

  • ITelemetryWriter interface (write, reset, getName)
  • ITelemetryReader interface (getSnapshot, getName)
  • InMemoryTelemetry implementing both interfaces
  • FileTelemetry and NetworkTelemetry implementing only Writer

Investigation Needed

  1. Verify actual implementation: Check if ITelemetryWriter and ITelemetryReader interfaces exist in codebase
  2. Check interface split: Verify if Reader/Writer split is actually implemented or if single ITelemetryProvider is used
  3. Bridge integration: Verify if bridge actually uses Writer interface for telemetry
  4. Presentation integration: Verify if presentation uses Reader interface

Potential Issues

If the codebase doesn't match the documented Reader/Writer split:

Files to Check

  • engine-sim-bridge/include/ITelemetryProvider.h (does this exist?)
  • src/ for telemetry-related code
  • src/interfaces/ for telemetry reader/writer usage

Acceptance Criteria

  • Actual telemetry implementation verified against documentation
  • Documentation updated to match actual implementation
  • Either Reader/Writer split confirmed and documented OR documentation corrected to actual implementation
  • No contradictions between docs and code

Related Issues

Notes

This issue requires investigation of actual codebase to determine if Reader/Writer split is implemented. If not, this may be another case of documentation describing planned but unimplemented architecture.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions