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

docs(metric): document public interfaces with versioning policy #3441

Merged
merged 2 commits into from Nov 6, 2022
Merged

docs(metric): document public interfaces with versioning policy #3441

merged 2 commits into from Nov 6, 2022

Conversation

wisdommatt
Copy link
Contributor

@wisdommatt wisdommatt commented Nov 4, 2022 •
edited

  • Add documentation comments to exported metric interfaces stating they cannot be changed.

Resolves #3384

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 4, 2022 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: wisdommatt / name: Wisdom Matthew (54bcf69)

Aneurysm9
Aneurysm9 reviewed Nov 4, 2022
View reviewed changes
metric/config.go Outdated Show resolved Hide resolved
@Aneurysm9 Aneurysm9 added pkg:API Related to an API package area:metrics Part of OpenTelemetry Metrics Skip Changelog PRs that do not require a CHANGELOG.md entry labels Nov 4, 2022
@Aneurysm9 Aneurysm9 added this to the Metric v0.34.0 milestone Nov 4, 2022
Aneurysm9
Aneurysm9 approved these changes Nov 4, 2022
View reviewed changes
Copy link
Member

@Aneurysm9 Aneurysm9 left a comment

Choose a reason for hiding this comment

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

I'm good with this, with the caveat that #3277 still needs to be addressed and we'll need to apply the resolution to these interfaces as well.

@codecov
Copy link

codecov bot commented Nov 4, 2022

Codecov Report

Merging #3441 (2e00439) into main (6dccc07) will decrease coverage by 0.0%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main   #3441     +/-   ##
=======================================
- Coverage   77.8%   77.8%   -0.1%     
=======================================
  Files        164     164             
  Lines      11494   11494             
=======================================
- Hits        8948    8946      -2     
- Misses      2343    2345      +2     
  Partials     203     203
Impacted Files Coverage Δ
sdk/trace/batch_span_processor.go 81.1% <0.0%> (-0.9%) ⬇️

@dmathieu
Copy link
Member

dmathieu commented Nov 6, 2022

If we document this for metric interfaces, should we also document it for trace ones ?

@MrAlias
Copy link
Contributor

MrAlias commented Nov 6, 2022

If we document this for metric interfaces, should we also document it for trace ones ?

It was done in #2012

@MrAlias MrAlias merged commit 7707ce3 into open-telemetry:main Nov 6, 2022
@wisdommatt wisdommatt deleted the wisdommatt/docs/public-interfaces-versioning-policy branch November 6, 2022 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Aneurysm9 Aneurysm9 Aneurysm9 approved these changes

@MrAlias MrAlias MrAlias approved these changes

@jmacd jmacd Awaiting requested review from jmacd

@evantorrie evantorrie Awaiting requested review from evantorrie evantorrie is a code owner

@XSAM XSAM Awaiting requested review from XSAM XSAM is a code owner

@dashpole dashpole Awaiting requested review from dashpole dashpole is a code owner

@MadVikingGod MadVikingGod Awaiting requested review from MadVikingGod MadVikingGod is a code owner

@pellared pellared Awaiting requested review from pellared pellared is a code owner

@hanyuancheung hanyuancheung Awaiting requested review from hanyuancheung hanyuancheung is a code owner

@dmathieu dmathieu Awaiting requested review from dmathieu dmathieu is a code owner

Assignees
No one assigned
Labels
area:metrics Part of OpenTelemetry Metrics pkg:API Related to an API package Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
No open projects
Go: Metric API (GA)
Status: Done
Milestone
Metric v0.34.0
Development

Successfully merging this pull request may close these issues.

Document public interfaces with versioning policy
4 participants
@wisdommatt @dmathieu @MrAlias @Aneurysm9