Skip to content
This repository was archived by the owner on Nov 17, 2025. It is now read-only.

Explain the Metric API instruments#98

Merged
bogdandrutu merged 25 commits intoopen-telemetry:masterfrom
jmacd:jmacd/98
May 6, 2020
Merged

Explain the Metric API instruments#98
bogdandrutu merged 25 commits intoopen-telemetry:masterfrom
jmacd:jmacd/98

Conversation

@jmacd
Copy link
Copy Markdown
Contributor

@jmacd jmacd commented Apr 18, 2020 •
edited
Loading

This document replaces OTEPs #93 and #96.

The number of instruments is expanded to 6.

Resolves open-telemetry/opentelemetry-specification#467
Resolves open-telemetry/opentelemetry-specification#465
Resolves open-telemetry/opentelemetry-specification#462

@jmacd jmacd added the metrics Relates to the Metrics API/SDK label Apr 18, 2020
This was referenced Apr 18, 2020
Closed
Closed
@c24t c24t mentioned this pull request Apr 20, 2020
Closed
MrAlias
MrAlias reviewed Apr 21, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@MrAlias MrAlias left a comment

Choose a reason for hiding this comment

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

Good start. I especially appreciate the added "Example uses" in the relevant details sections as well as the propagated table outlining the metrics.

@jmacd jmacd changed the title WIP: Explain the Metric API instruments Explain the Metric API instruments Apr 23, 2020
bogdandrutu
bogdandrutu approved these changes Apr 23, 2020
View reviewed changes
bogdandrutu
bogdandrutu reviewed Apr 23, 2020
View reviewed changes
@jmacd jmacd marked this pull request as ready for review April 28, 2020 05:49
@jmacd jmacd mentioned this pull request Apr 28, 2020
Closed
@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented Apr 28, 2020

Thanks @MikeGoldsmith @codeboten. I found other .md files in OTel that use a syntax to avoid repeating the same link a million times, and used that for otep-88 here.

bogdandrutu
bogdandrutu reviewed Apr 28, 2020
View reviewed changes
@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented Apr 29, 2020

There is an outstanding discussion here, #98 (comment), but it's not about the matter at hand. If we agree about the names of the instruments and their default aggregation, then I think this PR is ready to merge.

The debate above is about how we document the protocol and the internals of the SDK and export pipeline. I do not think the outcome of this debate will have an impact on the specification we write for the API. In any case we shouldn't hold this up over a decision about use of "Temporal quality" in the API documentation.

cijothomas
cijothomas approved these changes Apr 29, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

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

Agree the stated purpose of defining standard instrument names and their default aggregations is met!
Thanks.

lzchen
lzchen approved these changes Apr 29, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@lzchen lzchen left a comment

Choose a reason for hiding this comment

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

Really well explained! Good job!

tigrannajaryan
tigrannajaryan reviewed May 1, 2020
View reviewed changes
@bogdandrutu
Copy link
Copy Markdown
Member

bogdandrutu commented May 2, 2020

@open-telemetry/specs-approvers this OTEP got very popular, can we review this to make progress?

@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented May 4, 2020

@open-telemetry/specs-approvers please approve this. We have reached agreement by all, and the only outstanding discussion point belongs to the SDK: open-telemetry/opentelemetry-proto#147

@bogdandrutu
Copy link
Copy Markdown
Member

bogdandrutu commented May 5, 2020

Please fix markdown lint errors :)

jmacd added 2 commits May 5, 2020 09:20
@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented May 5, 2020

@bogdandrutu Done. Needs one more approver 😆

@jmacd
Copy link
Copy Markdown
Contributor Author

jmacd commented May 6, 2020

@bogdandrutu Let's merge this.

@bogdandrutu bogdandrutu merged commit 2e37507 into open-telemetry:master May 6, 2020
@bogdandrutu
Copy link
Copy Markdown
Member

bogdandrutu commented May 6, 2020

Yes Sir :)

@jmacd jmacd deleted the jmacd/98 branch May 6, 2020 18:48
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 23, 2024
@jmacd
Explain the Metric API instruments (open-telemetry#98)
cfcd4ba 
* Nine instruments

* WIP: More explanation, starting on details section

* Introduction

* Typo fix

* Table fmt

* Rewrite without async delta instruments

* More examples

* Draft is ready

* More names considered

* More examples from review feedback

* From comments

* Typos

* Address question about MMSC

* About ValueObserver temporal quality

* More on temporal quality terminology

* 88 links to otep 88

* Swap temporal quality and default aggregation columns

* Move link ref

* Add 'Input' to the temporal quality header

* Add detail

* Rename into ./metrics

* Lint

* Lint
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 23, 2024
@jmacd
Explain the Metric API instruments (open-telemetry#98)
90a469f 
* Nine instruments

* WIP: More explanation, starting on details section

* Introduction

* Typo fix

* Table fmt

* Rewrite without async delta instruments

* More examples

* Draft is ready

* More names considered

* More examples from review feedback

* From comments

* Typos

* Address question about MMSC

* About ValueObserver temporal quality

* More on temporal quality terminology

* 88 links to otep 88

* Swap temporal quality and default aggregation columns

* Move link ref

* Add 'Input' to the temporal quality header

* Add detail

* Rename into ./metrics

* Lint

* Lint
carlosalberto pushed a commit to carlosalberto/oteps that referenced this pull request Oct 30, 2024
@jmacd
Explain the Metric API instruments (open-telemetry#98)
70620b7 
* Nine instruments

* WIP: More explanation, starting on details section

* Introduction

* Typo fix

* Table fmt

* Rewrite without async delta instruments

* More examples

* Draft is ready

* More names considered

* More examples from review feedback

* From comments

* Typos

* Address question about MMSC

* About ValueObserver temporal quality

* More on temporal quality terminology

* 88 links to otep 88

* Swap temporal quality and default aggregation columns

* Move link ref

* Add 'Input' to the temporal quality header

* Add detail

* Rename into ./metrics

* Lint

* Lint
carlosalberto pushed a commit to open-telemetry/opentelemetry-specification that referenced this pull request Nov 8, 2024
@jmacd @carlosalberto
Explain the Metric API instruments (open-telemetry/oteps#98)
8fdad29 
* Nine instruments

* WIP: More explanation, starting on details section

* Introduction

* Typo fix

* Table fmt

* Rewrite without async delta instruments

* More examples

* Draft is ready

* More names considered

* More examples from review feedback

* From comments

* Typos

* Address question about MMSC

* About ValueObserver temporal quality

* More on temporal quality terminology

* 88 links to otep 88

* Swap temporal quality and default aggregation columns

* Move link ref

* Add 'Input' to the temporal quality header

* Add detail

* Rename into ./metrics

* Lint

* Lint
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@arminru arminru Awaiting requested review from arminru

@c24t c24t Awaiting requested review from c24t

@iredelmeier iredelmeier Awaiting requested review from iredelmeier

@reyang reyang Awaiting requested review from reyang

@SergeyKanzhelev SergeyKanzhelev Awaiting requested review from SergeyKanzhelev

@tedsuo tedsuo Awaiting requested review from tedsuo

10 more reviewers

@jkwatson jkwatson jkwatson approved these changes

@bogdandrutu bogdandrutu bogdandrutu approved these changes

@codeboten codeboten codeboten approved these changes

@carlosalberto carlosalberto carlosalberto approved these changes

@MikeGoldsmith MikeGoldsmith MikeGoldsmith approved these changes

@yurishkuro yurishkuro yurishkuro approved these changes

@tigrannajaryan tigrannajaryan tigrannajaryan approved these changes

@cijothomas cijothomas cijothomas approved these changes

@MrAlias MrAlias MrAlias approved these changes

@lzchen lzchen lzchen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

metrics Relates to the Metrics API/SDK

Projects

None yet

Milestone

No milestone