Skip to content

fix(node): allow passing in plugin loader instead of a module path #1854

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

Closed
wants to merge 1 commit into from
Closed

fix(node): allow passing in plugin loader instead of a module path #1854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions packages/opentelemetry-core/src/trace/Plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@ export interface PluginConfig {
*/
path?: string;

/**
* Function to load the plugin. Needed in environments like Yarn PnP
* where modules cannot use require() to load modules not listed in their
* own dependencies.
*
* Example: `loader: () => require('@opentelemetry/plugin-xxx').plugin`
*/
loader?: () => Plugin;

/**
* Request methods that match any string in ignoreMethods will not be traced.
*/
Expand Down
4 changes: 3 additions & 1 deletion packages/opentelemetry-node/src/instrumentation/PluginLoader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,9 @@ export class PluginLoader {

// Expecting a plugin from module;
try {
const plugin: Plugin = require(modulePath).plugin;
const plugin: Plugin = config.loader
? config.loader()
: require(modulePath).plugin;
if (!utils.isSupportedVersion(version, plugin.supportedVersions)) {
this.logger.warn(
`PluginLoader#load: Plugin ${name} only supports module ${plugin.moduleName} with the versions: ${plugin.supportedVersions}`
Expand Down