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

[sdk-metrics] Promote cardinality limit view API from experimental to stable #5926

Merged
merged 6 commits into from
Oct 28, 2024
Merged

[sdk-metrics] Promote cardinality limit view API from experimental to stable #5926

merged 6 commits into from
Oct 28, 2024

Conversation

xiang17
Copy link
Contributor

@xiang17 xiang17 commented Oct 25, 2024 •
edited
Loading

Fixes #5444.

Changes

Promote cardinality limit view API from experimental to stable. Updates README and obsolete flags for MeterProviderBuilder.SetMaxMetricPointsPerMetricStream to note that they are in stable.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
  • Unit tests added/updated
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable): The APIs were in src\OpenTelemetry\.publicApi\Experimental\PublicAPI.Unshipped.txt.

@github-actions github-actions bot added infra Infra work - CI/CD, code coverage, linters documentation Documentation related pkg:OpenTelemetry Issues related to OpenTelemetry NuGet package labels Oct 25, 2024
@codecov Codecov
Copy link

codecov bot commented Oct 25, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.02%. Comparing base (6250307) to head (53ed5af).
Report is 361 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5926      +/-   ##
==========================================
+ Coverage   83.38%   86.02%   +2.64%     
==========================================
  Files         297      260      -37     
  Lines       12531    11437    -1094     
==========================================
- Hits        10449     9839     -610     
+ Misses       2082     1598     -484
Flag Coverage Δ
unittests ?
unittests-Project-Experimental 85.95% <ø> (?)
unittests-Project-Stable 86.00% <ø> (?)
unittests-Solution 85.95% <ø> (?)
unittests-UnstableCoreLibraries-Experimental 84.36% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
.../Metrics/Builder/MeterProviderBuilderExtensions.cs 98.42% <ø> (-1.58%) ⬇️
...elemetry/Metrics/View/MetricStreamConfiguration.cs 88.88% <ø> (ø)

... and 237 files with indirect coverage changes

@xiang17 xiang17 marked this pull request as ready for review October 25, 2024 22:48
@xiang17 xiang17 requested a review from a team as a code owner October 25, 2024 22:48
reyang
reyang reviewed Oct 25, 2024
View reviewed changes
docs/diagnostics/experimental-apis/README.md
@@ -58,3 +52,11 @@ Description: Metrics Exemplar Support
Details: [OTEL1002](https://github.com/open-telemetry/opentelemetry-dotnet/blob/b8ea807bae1a5d9b0f3d6d23b1e1e10f5e096a25/docs/diagnostics/experimental-apis/OTEL1002.md)

Released stable: `1.9.0`

### OTEL1003
Copy link
Member

Choose a reason for hiding this comment

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

Does this need to be moved?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was simply following the convention of the OTEL1002 above which was released and moved from "Active" to "Inactive". Personally I think it'd also be helpful to have a record of what happened to previous experimental features.

reyang
reyang reviewed Oct 25, 2024
View reviewed changes
src/OpenTelemetry/CHANGELOG.md
@@ -6,6 +6,11 @@ Notes](../../RELEASENOTES.md).

## Unreleased

* The experimental APIs previously covered by `OTEL1003`
(`MetricStreamConfiguration.CardinalityLimit`) will now be part of the public
Copy link
Member

Choose a reason for hiding this comment

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

will be -> is?

Copy link
Member

Choose a reason for hiding this comment

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

I wonder how folks think about https://www.theregister.com/2024/10/08/linus_torvalds_grammar_complaint/?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This wording is also used in other experimental APIs in this CHANGELOG.

Copy link
Member

Choose a reason for hiding this comment

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

I think "is" is better. Would be good to follow up and make changes everywhere. Not a blocker for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Created a PR #5940 for this.

reyang
reyang approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

Left couple suggestions/questions that are non-blocking.

@CodeBlanch CodeBlanch changed the title Promote cardinality limit view API from experimental to stable [sdk-metrics] Promote cardinality limit view API from experimental to stable Oct 28, 2024
@CodeBlanch CodeBlanch added the metrics Metrics signal related label Oct 28, 2024
@CodeBlanch CodeBlanch merged commit 8de335c into open-telemetry:main Oct 28, 2024
49 checks passed
@xiang17 xiang17 deleted the xiang17/CardinalityLimitViewApi branch October 29, 2024 23:40
@xiang17 xiang17 mentioned this pull request Oct 30, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cijothomas cijothomas cijothomas approved these changes

@reyang reyang reyang approved these changes

@rajkumar-rangaraj rajkumar-rangaraj rajkumar-rangaraj approved these changes

Assignees
No one assigned
Labels
documentation Documentation related infra Infra work - CI/CD, code coverage, linters metrics Metrics signal related pkg:OpenTelemetry Issues related to OpenTelemetry NuGet package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Promote cardinality limit view API from experimental to stable
5 participants
@xiang17 @cijothomas @rajkumar-rangaraj @reyang @CodeBlanch