Skip to content

Conversation

@peerst
Copy link

@peerst peerst commented Oct 29, 2025

  • Why: Enable non-Erlang reviewers to validate implementation against the OpenTelemetry Metrics spec without diving into Erlang code.

  • What: Adds complete, reviewer-friendly documentation across the experimental API and SDK:

    • API (apps/opentelemetry_api_experimental/)
      • SPEC_COMPLIANCE.md
      • ARCHITECTURE.md
      • REVIEW_GUIDE.md
      • GLOSSARY.md
      • TEST_COVERAGE.md
      • README updated with a “For non-Erlang reviewers” section
    • SDK (apps/opentelemetry_experimental/)
      • SPEC_COMPLIANCE.md
      • ARCHITECTURE.md (with sequence diagrams)
      • REVIEW_GUIDE.md
      • CONFIG_RECIPES.md
      • GLOSSARY.md
      • TEST_COVERAGE.md
      • README updated with a “For non-Erlang reviewers” section
  • How to review

    • Start with apps/opentelemetry_api_experimental/SPEC_COMPLIANCE.md, then apps/opentelemetry_experimental/SPEC_COMPLIANCE.md.
    • Skim ARCHITECTURE.md in both apps for component responsibilities and flows.
    • Use apps/opentelemetry_experimental/REVIEW_GUIDE.md and CONFIG_RECIPES.md to validate behavior end-to-end (console reader recommended).
  • Highlights

    • Clear spec-to-code crosswalk with code anchors for views, readers, aggregations, temporality, and observables.
    • Concise quickstart validation steps for each instrument type and common configurations.
    • Glossaries to map Erlang/OpenTelemetry terminology to language-agnostic concepts.
  • Scope

    • Documentation only; no runtime behavior changes.
  • Follow-ups (optional)

    • Add @doc summaries on key exported functions in otel_view, otel_metric_reader, and otel_meter_server to align inline docs with these files.
  • Checklist

    • Links render correctly on GitHub
    • Mermaid diagrams render in ARCHITECTURE.md
    • Spelling/terminology pass
    • Team sign-off on doc structure/content

…s, glossary, and test coverage for experimental API and SDK
@peerst peerst requested a review from a team as a code owner October 29, 2025 13:48
@linux-foundation-easycla
Copy link

CLA Not Signed

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.

1 participant