-
Notifications
You must be signed in to change notification settings - Fork 829
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.
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
[sdk-metrics] remove MetricAdvice
type workaround
#5224
Labels
needs:code-contribution
This feature/bug is ready to implement
pkg:sdk-metrics
target:next-major-release
This PR targets the next major release (`next` branch)
type:feature
A feature with no sub-issues to address
Milestone
Comments
pichlermarc
added
pkg:sdk-metrics
type:feature
A feature with no sub-issues to address
needs:code-contribution
This feature/bug is ready to implement
target:next-major-release
This PR targets the next major release (`next` branch)
labels
Dec 1, 2024
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 11, 2024
These types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. Closes open-telemetry#5223 Closes open-telemetry#5224
8 tasks
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 12, 2024
The internal `Gauge` and the unnamed `MetricAdvice` types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. This is not expected to have any impact on consumers as the types are intended to be compatible for the positions they were used in. Closes open-telemetry#5223 Closes open-telemetry#5224
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 12, 2024
The internal `Gauge` and the unnamed `MetricAdvice` types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. This is not expected to have any impact on consumers as the types are intended to be compatible for the positions they were used in. Closes open-telemetry#5223 Closes open-telemetry#5224
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 12, 2024
The internal `Gauge` and the unnamed `MetricAdvice` types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. This is not expected to have any impact on consumers as the types are intended to be compatible for the positions they were used in. Fixes open-telemetry#5223 Fixes open-telemetry#5224
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 13, 2024
The internal `Gauge` and the unnamed `MetricAdvice` types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. This is not expected to have any impact on consumers as the types are intended to be compatible for the positions they were used in. Fixes open-telemetry#5223 Fixes open-telemetry#5224
chancancode
added a commit
to tildeio/opentelemetry-js
that referenced
this issue
Dec 13, 2024
The internal `Gauge` and the unnamed `MetricAdvice` types were introduced in the 1.0 series when the metrics package depended on an older version of the api package that didn't come with those types, so the interfaces were essentially vendored into the package for internal use. Now with the 2.0 release on the horrizon, we can bump the required version of @otel/api and is now safe to unvendor these types in favor of the official ones. This is not expected to have any impact on consumers as the types are intended to be compatible for the positions they were used in. However, the minimum requirement for the `@opentelemetry/api` peer dependency has been raised to 1.9.0. Fixes open-telemetry#5223 Fixes open-telemetry#5224
closed by #5254 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
needs:code-contribution
This feature/bug is ready to implement
pkg:sdk-metrics
target:next-major-release
This PR targets the next major release (`next` branch)
type:feature
A feature with no sub-issues to address
Description
Important
Only actionable for
next
branch. Any PRs opened for this MUST be based on and targeted at thenext
branch.In
@opentelemetry/sdk-metrics
some features were introduced that could not use@opentelemetry/api
types that were introduced after1.3.0
. Dropping support for older API vesions would be a breaking change. As a workaround, we duplicated the types from@opentelemetry/api
in@opentelemetry/sdk-metrics
.The goal of this issue is to remove these workarounds, and to use the
@opentelemetry/api
types directly instead.This issue is considered done when:
advice
property is replaced withMetricAdvice
from@opentelemetry/api
peerDependency
version on@opentelemetry/api
is raised to at least the version that is documented in the@since
version of the API'sMetricAdvice
type (1.7.0
)Additional context
opentelemetry-js/packages/sdk-metrics/src/InstrumentDescriptor.ts
Lines 46 to 58 in fc94e46
The text was updated successfully, but these errors were encountered: