Skip to content

fix(instrumentation)!: remove unused supportedVersions from Instrumentation interface #4694

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

Merged
pichlermarc merged 5 commits into from
May 13, 2024
Merged

fix(instrumentation)!: remove unused supportedVersions from Instrumentation interface #4694

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
78bceef
chore: CHANGLOG
blumamir May 10, 2024
e109475
fix(instrumentation): remove unused property from instrumentations
blumamir May 10, 2024
5050c3d
chore: CHANGELOG
blumamir May 10, 2024
3095b2e
Merge branch 'main' into remove-supported-versions
blumamir May 11, 2024
0433cb6
Merge branch 'main' into remove-supported-versions
pichlermarc May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ All notable changes to experimental packages in this project will be documented
* (internal) OTLPExporterBrowserBase: `RequestType` has been replaced by a `ResponseType` type-argument
* (internal) OTLPExporterNodeBase: `ServiceRequest` has been replaced by a `ServiceResponse` type-argument
* (internal) the `@opentelemetry/otlp-exporter-proto-base` package has been removed, and will from now on be deprecated in `npm`
* fix(instrumentation)!: remove unused supportedVersions from Instrumentation interface [#4694](https://github.com/open-telemetry/opentelemetry-js/pull/4694) @blumamir

### :rocket: (Enhancement)

Expand Down
10 changes: 0 additions & 10 deletions experimental/packages/opentelemetry-instrumentation/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,6 @@ export interface Instrumentation<

/** Method to get instrumentation config */
getConfig(): ConfigType;

/**
* Contains all supported versions.
* All versions must be compatible with [semver](https://semver.org/spec/v2.0.0.html) format.
* If the version is not supported, we won't apply instrumentation patch (see `enable` method).
* If omitted, all versions of the module will be patched.
*/
supportedVersions?: string[];
}

/**
Expand Down Expand Up @@ -102,8 +94,6 @@ export interface InstrumentationModuleFile {
/** Method to patch the instrumentation */
patch(moduleExports: unknown, moduleVersion?: string): unknown;

/** Method to patch the instrumentation */
Copy link
Member Author

@blumamir blumamir May 10, 2024

Choose a reason for hiding this comment

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

this is just a cleanup i spotted along the way


/** Method to unpatch the instrumentation */
unpatch(moduleExports?: unknown, moduleVersion?: string): void;
}
Expand Down