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.

Sign up for GitHub

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

Jump to bottom

WIP Metric v0.4 user-facing API specification #582

Closed
wants to merge 4 commits into from
Closed

WIP Metric v0.4 user-facing API specification #582

wants to merge 4 commits into from

Conversation

jmacd
Copy link
Contributor

@jmacd jmacd commented May 5, 2020 •
edited
Loading

This document accompanies the main API document, being updated in #581. Many of the examples from api.md have moved to this document.

This document is not ready for review. It has not been rewritten with the new instrument names factored in.

@jmacd jmacd mentioned this pull request May 5, 2020
Merged
@arminru arminru added area:api Cross language API specification issue spec:metrics Related to the specification/metrics directory labels May 5, 2020
@arminru arminru added this to the v0.4 milestone May 5, 2020
@jmacd
Copy link
Contributor Author

jmacd commented May 5, 2020

I am about half-way through revising this document. (Stay tuned.)

@jmacd
Copy link
Contributor Author

jmacd commented May 6, 2020

For the record, I removed

In this document, the term "aggregation" is used to describe the
process of coalescing metric events for a complete set of labels,
whereas "grouping" is used to describe further coalescing aggregate
metric data into a reduced number of key dimensions.  SDKs may be
designed to perform aggregation and/or grouping in the process, with
various trade-offs in terms of complexity and performance.

because I couldn't decide if/where it fits.

jmacd
jmacd commented May 6, 2020
View reviewed changes
specification/metrics/api-user.md
@@ -309,6 +338,20 @@ an exporter, and where there are keys that are missing, the SDK is required to
consider these values _explicitly unspecified_, a distinct value type of the
exported data model.

##### Option: Labels using a built-in type
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkwatson I re-inserting this (lost content) here.

@jmacd
Copy link
Contributor Author

jmacd commented May 6, 2020

This approach is not going to work. I now believe we should combine all the documents in this file into a single file.

@jmacd jmacd closed this May 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
area:api Cross language API specification issue spec:metrics Related to the specification/metrics directory
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.
2 participants
@jmacd @arminru