Metric SDK Accumulator requirements and details #880
Conversation
|
I'm trying to wrap my head around how this all maps to the existing Java implementation. I think that, roughly, what you call an For example, in Java, there is not really a single thing that "Receives metric events from the API, computes one Accumulation per active Instrument and Label Set pair" This is done in the individual Instrument implementation instances, with the assistance of an associated Aggregator. So, I understand that this is supposed to be documenting a "model" implementation of the SDK, but I'm worried that, when we get ready for GA, we'll have a feature matrix, like we do for tracing, that will basically have to be completely blank (or minus-signs) for Java, since we won't have any of these components. I'd love to see a document that outlines the functionality that an SDK MUST provide, aside from this model implementation, which reads very prescriptive in its language, despite the insistence that this is only describing one possible implementation. |
Co-authored-by: Aaron Abbott <aaronabbott@google.com>
|
@jkwatson your feedback is valuable. Let me know how we can get this merged so that we can keep refining this document (together). Thanks. |
jmacd
changed the title
|
@open-telemetry/specs-metrics-approvers PTAL. I've reorganized the material in this draft to call out a separate "SDK" and "Accumulator" components to try and address confusion raised by several reviewers. I added a new diagram to clarify data flow through the Accumulator. |
Thanks @MrAlias Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
|
@bogdandrutu I think this is ready. |
* Metric SDK Accumulator details * Add changelog * Newline * Apply suggestions from code review Co-authored-by: Aaron Abbott <aaronabbott@google.com> * Fix link * Add detail on MeterImpl wrapper * Update specification/metrics/sdk.md Co-authored-by: John Watson <jkwatson@gmail.com> * Use ```go * From recent feedback * Edits * Typo * De-lint * Refinements about Accumulator * Lint * Reword what Accumulator implements * Address question about duplicate registration * Add Accumulator.Collect() requirements * Spelling * Add controller to diagram * Provider->MeterProvider * Add image link * Update image * Make SDK vs Accumulator more distinct * Move some Accumulator requirements into SDK requirements * Spelling * Lint * Remove uses of "itself"; edits * Move the diagram * Apply suggestions from code review Thanks @MrAlias Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * Merge (again) Co-authored-by: Aaron Abbott <aaronabbott@google.com> Co-authored-by: John Watson <jkwatson@gmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
Changes
Adds detail on the SDK Accumulator components and its responsibilities to the OpenTelemetry Metric API.
Fixes #626. This now includes at least a full skeleton of the document.
Fixes #607.