docs(experimental): reviewer-focused documentation for Metrics API/SDK (spec crosswalks, architecture, review guides)#928
Open
peerst wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
…s, glossary, and test coverage for experimental API and SDK
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
apps/opentelemetry_api_experimental/)SPEC_COMPLIANCE.mdARCHITECTURE.mdREVIEW_GUIDE.mdGLOSSARY.mdTEST_COVERAGE.mdapps/opentelemetry_experimental/)SPEC_COMPLIANCE.mdARCHITECTURE.md(with sequence diagrams)REVIEW_GUIDE.mdCONFIG_RECIPES.mdGLOSSARY.mdTEST_COVERAGE.mdHow to review
apps/opentelemetry_api_experimental/SPEC_COMPLIANCE.md, thenapps/opentelemetry_experimental/SPEC_COMPLIANCE.md.ARCHITECTURE.mdin both apps for component responsibilities and flows.apps/opentelemetry_experimental/REVIEW_GUIDE.mdandCONFIG_RECIPES.mdto validate behavior end-to-end (console reader recommended).Highlights
Scope
Follow-ups (optional)
@docsummaries on key exported functions inotel_view,otel_metric_reader, andotel_meter_serverto align inline docs with these files.Checklist
ARCHITECTURE.md