feat(sdk-metrics)!: drop deprecated type field on MetricDescriptor
#5291
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move the field to the internal `InstrumentDescriptor` type and keep it for internal use. Fixes open-telemetry#3439
chancancode
commented
Dec 20, 2024
| @@ -7,6 +7,8 @@ All notable changes to experimental packages in this project will be documented | |||
|
|
|||
| ### :boom: Breaking Change | |||
|
|
|||
| * feat(exporter-prometheus)!, feat(shim-opencensus)!: drop support for the deprecated `type` field on `MetricDescriptor` [#5291](https://github.com/open-telemetry/opentelemetry-js/pull/5291) | |||
There was a problem hiding this comment.
Not exactly sure what to say here, there is probably more to say, since, as the test shown this change can have noticeable impact
chancancode
commented
Dec 20, 2024
| !name.endsWith('_total') && | ||
| data.dataPointType === DataPointType.SUM && | ||
| data.isMonotonic | ||
| ) { |
There was a problem hiding this comment.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5291 +/- ##
=======================================
Coverage 94.62% 94.62%
=======================================
Files 323 323
Lines 8068 8071 +3
Branches 1637 1640 +3
=======================================
+ Hits 7634 7637 +3
Misses 434 434
|
chancancode
commented
Dec 20, 2024
| 'metric_observable_counter{key1="attributeValue1"} 20', | ||
| '# HELP metric_observable_counter_total a test description', | ||
| '# TYPE metric_observable_counter_total counter', | ||
| 'metric_observable_counter_total{key1="attributeValue1"} 20', | ||
| '', | ||
| ]); | ||
| }); |
There was a problem hiding this comment.
@pichlermarc I think this is the natural conclusion of your proposed check right? (or– did I misunderstood your comment and flipped the check?)
chancancode
commented
Dec 20, 2024
| @@ -374,6 +380,9 @@ describe('Instruments', () => { | |||
| unit: '', | |||
| type: InstrumentType.HISTOGRAM, | |||
| valueType: ValueType.INT, | |||
| advice: { | |||
| explicitBucketBoundaries: [1, 9, 100], | |||
| }, | |||
There was a problem hiding this comment.
The previous test should have this but left it out due to it not being enforced by the type. Internally that went to assertPartialDeepStrictEqual and that was only checking everything appears here (expected) is present and === on the actual, but not the other way around.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Drop deprecated
typefield onMetricDescriptorFixes #3439
Fixes #5266 (review) (@pichlermarc)
Short description of the changes
Move the field to the internal
InstrumentDescriptortype and keep it for internal use.See also: #5266 (comment)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
npm compilenpm lintnpm test:*Checklist:
addedupdated