Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metrics SDK specification: what should this document contain? #626

Closed
jmacd opened this issue May 29, 2020 · 4 comments · Fixed by #880
Closed

Metrics SDK specification: what should this document contain? #626

jmacd opened this issue May 29, 2020 · 4 comments · Fixed by #880
Assignees
Labels
area:sdk Related to the SDK priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:metrics Related to the specification/metrics directory

Comments

@jmacd
Copy link
Contributor

jmacd commented May 29, 2020

This draft PR #347 is six months old and quite out of date. I am committed to revising this document and finishing it, but I am concerned that I--standing near the center of this project for so long--will either write about things that are not important or fail to write about things that are important.

This issue is meant to collect requirements for the final SDK specification document. What MUST it contain? These are the topics I am aware of:

Architectural diagram: Accumulator, Integrator, Export path
Aggregators: Which SHOULD and which MUST be included. Define their semantics.
Resources: ??
Configuration: ??

@jkwatson

@jmacd jmacd added the spec:metrics Related to the specification/metrics directory label May 29, 2020
@jkwatson
Copy link
Contributor

Glossary, for sure (if that's not already somewhere).
How to configure Resources seems like a big one that's currently absent.
What is configurable at runtime seems like an important item, as well.

One question I have: how prescriptive is the accumulator/integrator/etc naming? I ask because the Java SDK doesn't have things named that at this point, and different languages might want different structures for performance reasons. Can those things be conceptual, rather than prescriptive, I wonder?

@cijothomas
Copy link
Member

I'd love to see customization points in the SDK spec. For example, Tracing Spec has well defined SpanProcessor, SpanExporter and user can write their own ones looking at the spec, and plug it into TracerProviders.

Would love to have metrics SDK specify - what are the things which one can customize, and how. eg: can I change Aggregator to a custom defined one? If yes, how to write one (which interface to implement), and how to plug it in.

I assume Views are going to be covered in SDK spec as well.

@jmacd
Copy link
Contributor Author

jmacd commented Jun 4, 2020

@cijothomas Yes, a lot of the document will go toward extension points. Those points are named Integrator, Exporter, and Aggregator. Thanks.

@carlosalberto carlosalberto added the area:sdk Related to the SDK label Jun 26, 2020
@jmacd jmacd added the release:required-for-ga Must be resolved before GA release, or nice to have before GA label Jun 29, 2020
@bogdandrutu bogdandrutu added the priority:p1 Highest priority level label Jul 24, 2020
@andrewhsu
Copy link
Member

discussed this at the spec sig mtg today, and looks like @jmacd is working on this with #347 so initially assigning to him

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:sdk Related to the SDK priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants