opentelemetry-erlang
opentelemetry-erlang copied to clipboard
docs(experimental): reviewer-focused documentation for Metrics API/SDK (spec crosswalks, architecture, review guides)
-
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.mdARCHITECTURE.mdREVIEW_GUIDE.mdGLOSSARY.mdTEST_COVERAGE.md- README updated with a “For non-Erlang reviewers” section
- SDK (
apps/opentelemetry_experimental/)SPEC_COMPLIANCE.mdARCHITECTURE.md(with sequence diagrams)REVIEW_GUIDE.mdCONFIG_RECIPES.mdGLOSSARY.mdTEST_COVERAGE.md- README updated with a “For non-Erlang reviewers” section
- API (
-
How to review
- Start with
apps/opentelemetry_api_experimental/SPEC_COMPLIANCE.md, thenapps/opentelemetry_experimental/SPEC_COMPLIANCE.md. - Skim
ARCHITECTURE.mdin both apps for component responsibilities and flows. - Use
apps/opentelemetry_experimental/REVIEW_GUIDE.mdandCONFIG_RECIPES.mdto validate behavior end-to-end (console reader recommended).
- Start with
-
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
@docsummaries on key exported functions inotel_view,otel_metric_reader, andotel_meter_serverto align inline docs with these files.
- Add
-
Checklist
- [ ] Links render correctly on GitHub
- [ ] Mermaid diagrams render in
ARCHITECTURE.md - [ ] Spelling/terminology pass
- [ ] Team sign-off on doc structure/content
- :x: - login: @peerst / name: Peer Stritzinger . The commit (a5b4aba933acfac442d18802452428759f54b86c) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.