[instrumentation] hide shimmer
types from the public API
#4837
Labels
needs:code-contribution
This feature/bug is ready to implement
never-stale
pkg:instrumentation
type:feature
A feature with no sub-issues to address
Description:
@types/shimmer
is currently part of the@opentelemetry/instrumentation
package's public API. We should avoid having a third-party dependency be part of the public API of this package as breaking changes will affect the public interface of@opentelemetry/instrumentation
A solution to this can be changing
InstrumentationAbstract#_wrap
,InstrumentationAbstract#_unwrap
,InstrumentationAbstract#massUnwrap
,InstrumentationAbstract#massWrap
to be custom functions that wrapshimmer
functions and for which we fully control the types.This issue is considered done when:
shimmer
,@types/shimmer
exports are hidden in a way so that they are not part of the public API anymore@types/shimmer
is moved todevDependenices
or removed completelyAdditional Details
Code sections of interest:
opentelemetry-js/experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts
Lines 73 to 80 in 01a2c35
opentelemetry-js/experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts
Lines 82 to 152 in 01a2c35
This issue is part of #4586
The text was updated successfully, but these errors were encountered: