InstrumentationDescriptor

Database module, such as the MongoDB or MySQL drivers.

Utility/generic module.

Messaging module, such as AMQP.

Promise module, such as Bluebird.

Used to load supportability metrics on installed versions of packages that the Node.js agent does not instrument (e.g. OTEL instrumentation or top logging libraries).

Web server framework module, such as Express or Fastify.

The absolute path to the module to instrument. This should only be set when the module being instrumented does not reside in a node_modules directory; for example, when someone is instrumenting a module of their own through the public API.

The moduleName property still needs to be set to the simple name, i.e. the string passed to require, for instrumentation tracking purposes.

Note: this value takes precedence over moduleName.

Identifier for the instrumentation. Used by the internal instrumentation tracker to distinguish between different instrumentations targeting the same module.

The name of the module being instrumented, i.e. the string used to require the module. This must map to a directory in lib/instrumentations which contains an nr-hooks.js file.

This takes precedence over moduleName.

The name of the module being instrumented, i.e. the string used to require the module. This must map to a JavaScript file of the same name in the lib/instrumentations directory.

Hook to invoke when the onRequire hook throws an error.

Hook to invoke when the module is required. This is the actual implementation of the instrumentation.

The fully resolved path to the module, e.g. /opt/app/node_modules/foo. If the module is a core module, the special value . should be used.

Used when instrumenting a module to determine if a module has already been wrapped by a specific shim instance. It is used in conjunction with the shim.id value.

The type of the module being instrumented. See the static TYPE_ fields.