newrelic 13.3.2 → 13.4.0

package/NEWS.md

@@ -1,3 +1,43 @@
+### v13.4.0 (2025-09-29)
+
+#### Code refactoring
+
+* Update `amqplib` instrumentation to subscribe to events emitted ([#3377](https://github.com/newrelic/node-newrelic/pull/3377)) ([fecbb08](https://github.com/newrelic/node-newrelic/commit/fecbb08d3e3ddc31049aae07537da5d44efaa9e7))
+* Updated `cassandra-driver` instrumentation to subscribe to events emitted. ([#3372](https://github.com/newrelic/node-newrelic/pull/3372)) ([bb87cd8](https://github.com/newrelic/node-newrelic/commit/bb87cd829aacbc66e9caee4f7c494babab742f86))
+
+#### Documentation
+
+* Updated compatibility report ([#3385](https://github.com/newrelic/node-newrelic/pull/3385)) ([b79be72](https://github.com/newrelic/node-newrelic/commit/b79be723abd29a81c9fa2b635118de44be78c69b))
+
+#### Miscellaneous chores
+
+* Updated `@apm-js-collab/tracing-hooks` to latest to take advantage of wasm optimizations ([#3398](https://github.com/newrelic/node-newrelic/pull/3398)) ([cda56cc](https://github.com/newrelic/node-newrelic/commit/cda56cc074c421064150163a02a561e69b23a6cb))
+
+#### Styles
+
+* Require `jsdoc/valid-types` and `jsdoc/check-param-names` ([#3368](https://github.com/newrelic/node-newrelic/pull/3368)) ([5d1b1d9](https://github.com/newrelic/node-newrelic/commit/5d1b1d94a82aaeb877a6fe783becbc8aea6582d6))
+* Require jsdoc `require-param-description` and `require-param-type` ([#3391](https://github.com/newrelic/node-newrelic/pull/3391)) ([3785d0c](https://github.com/newrelic/node-newrelic/commit/3785d0c06cfcc6ac85e23ad4ad21d357e334207b))
+
+### v13.3.3 (2025-09-22)
+
+#### Features
+
+* Added support for tracing callback on subscribers ([#3371](https://github.com/newrelic/node-newrelic/pull/3371)) ([e6ad52e](https://github.com/newrelic/node-newrelic/commit/e6ad52e1f897ec757e90f9fc12f592e1c6eec2fe))
+
+#### Bug fixes
+
+* Updated `openai` instrumentation to properly return APIPromise to avoid crashing when using `completions.parse` or `responses.parse` ([#3382](https://github.com/newrelic/node-newrelic/pull/3382)) ([c7ccf26](https://github.com/newrelic/node-newrelic/commit/c7ccf260ffc9c788bde73b43231b716199724d09))
+
+#### Documentation
+
+* Updated compatibility report ([#3370](https://github.com/newrelic/node-newrelic/pull/3370)) ([754c2f0](https://github.com/newrelic/node-newrelic/commit/754c2f089339268fb73a3ff7765a630ea8982d0d))
+
+#### Miscellaneous chores
+
+* Removed unused `loader.mjs` ([#3376](https://github.com/newrelic/node-newrelic/pull/3376)) ([66a9fd5](https://github.com/newrelic/node-newrelic/commit/66a9fd543d1a7854b7405c7b5b884d8a71773b85))
+* Updated metrics for OTel Bridge enablement/disablement ([#3381](https://github.com/newrelic/node-newrelic/pull/3381)) ([b976c37](https://github.com/newrelic/node-newrelic/commit/b976c376fe187bda5bde1b8cd4b86a7de86fe4f9))
+* Updated supportability metric names for OTel Bridge enablement… ([#3383](https://github.com/newrelic/node-newrelic/pull/3383)) ([c7c1d6c](https://github.com/newrelic/node-newrelic/commit/c7c1d6c942c6b53fd944e2259b42d1e7e7be483a))
+
 ### v13.3.2 (2025-09-10)
 
 #### Bug fixes
@@ -7885,3 +7925,6 @@ Special thanks to Ryan Copley (@RyanCopley) for the contribution.
 
 
 
+
+
+

package/THIRD_PARTY_NOTICES.md

@@ -98,7 +98,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 
 ### @apm-js-collab/tracing-hooks
 
-This product includes source derived from [@apm-js-collab/tracing-hooks](https://github.com/apm-js-collab/tracing-hooks) ([v0.1.1](https://github.com/apm-js-collab/tracing-hooks/tree/v0.1.1)), distributed under the [Apache-2.0 License](https://github.com/apm-js-collab/tracing-hooks/blob/v0.1.1/LICENSE):
+This product includes source derived from [@apm-js-collab/tracing-hooks](https://github.com/apm-js-collab/tracing-hooks) ([v0.3.1](https://github.com/apm-js-collab/tracing-hooks/tree/v0.3.1)), distributed under the [Apache-2.0 License](https://github.com/apm-js-collab/tracing-hooks/blob/v0.3.1/LICENSE):
 
 ```
 
@@ -308,7 +308,7 @@ This product includes source derived from [@apm-js-collab/tracing-hooks](https:/
 
 ### @grpc/grpc-js
 
-This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.13.4](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.13.4)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.13.4/LICENSE):
+This product includes source derived from [@grpc/grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) ([v1.14.0](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/tree/v1.14.0)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js/blob/v1.14.0/LICENSE):
 
 ```
                                  Apache License
@@ -726,7 +726,7 @@ This product includes source derived from [@grpc/proto-loader](https://github.co
 
 ### @newrelic/security-agent
 
-This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v2.4.3](https://github.com/newrelic/csec-node-agent/tree/v2.4.3)), distributed under the [UNKNOWN License](https://github.com/newrelic/csec-node-agent/blob/v2.4.3/LICENSE):
+This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v2.4.4](https://github.com/newrelic/csec-node-agent/tree/v2.4.4)), distributed under the [UNKNOWN License](https://github.com/newrelic/csec-node-agent/blob/v2.4.4/LICENSE):
 
 ```
 ## New Relic Software License v1.0
@@ -1190,7 +1190,7 @@ This product includes source derived from [@opentelemetry/api](https://github.co
 
 ### @opentelemetry/core
 
-This product includes source derived from [@opentelemetry/core](https://github.com/open-telemetry/opentelemetry-js) ([v2.0.1](https://github.com/open-telemetry/opentelemetry-js/tree/v2.0.1)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.0.1/LICENSE):
+This product includes source derived from [@opentelemetry/core](https://github.com/open-telemetry/opentelemetry-js) ([v2.1.0](https://github.com/open-telemetry/opentelemetry-js/tree/v2.1.0)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.1.0/LICENSE):
 
 ```
                                  Apache License
@@ -1608,7 +1608,7 @@ This product includes source derived from [@opentelemetry/exporter-metrics-otlp-
 
 ### @opentelemetry/resources
 
-This product includes source derived from [@opentelemetry/resources](https://github.com/open-telemetry/opentelemetry-js) ([v2.0.1](https://github.com/open-telemetry/opentelemetry-js/tree/v2.0.1)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.0.1/LICENSE):
+This product includes source derived from [@opentelemetry/resources](https://github.com/open-telemetry/opentelemetry-js) ([v2.1.0](https://github.com/open-telemetry/opentelemetry-js/tree/v2.1.0)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.1.0/LICENSE):
 
 ```
                                  Apache License
@@ -2026,7 +2026,7 @@ This product includes source derived from [@opentelemetry/sdk-logs](https://gith
 
 ### @opentelemetry/sdk-metrics
 
-This product includes source derived from [@opentelemetry/sdk-metrics](https://github.com/open-telemetry/opentelemetry-js) ([v2.0.1](https://github.com/open-telemetry/opentelemetry-js/tree/v2.0.1)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.0.1/LICENSE):
+This product includes source derived from [@opentelemetry/sdk-metrics](https://github.com/open-telemetry/opentelemetry-js) ([v2.1.0](https://github.com/open-telemetry/opentelemetry-js/tree/v2.1.0)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.1.0/LICENSE):
 
 ```
                                  Apache License
@@ -2235,7 +2235,7 @@ This product includes source derived from [@opentelemetry/sdk-metrics](https://g
 
 ### @opentelemetry/sdk-trace-base
 
-This product includes source derived from [@opentelemetry/sdk-trace-base](https://github.com/open-telemetry/opentelemetry-js) ([v2.0.1](https://github.com/open-telemetry/opentelemetry-js/tree/v2.0.1)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.0.1/LICENSE):
+This product includes source derived from [@opentelemetry/sdk-trace-base](https://github.com/open-telemetry/opentelemetry-js) ([v2.1.0](https://github.com/open-telemetry/opentelemetry-js/tree/v2.1.0)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v2.1.0/LICENSE):
 
 ```
                                  Apache License
@@ -2533,7 +2533,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### import-in-the-middle
 
-This product includes source derived from [import-in-the-middle](https://github.com/nodejs/import-in-the-middle) ([v1.14.2](https://github.com/nodejs/import-in-the-middle/tree/v1.14.2)), distributed under the [Apache-2.0 License](https://github.com/nodejs/import-in-the-middle/blob/v1.14.2/LICENSE):
+This product includes source derived from [import-in-the-middle](https://github.com/nodejs/import-in-the-middle) ([v1.14.4](https://github.com/nodejs/import-in-the-middle/tree/v1.14.4)), distributed under the [Apache-2.0 License](https://github.com/nodejs/import-in-the-middle/blob/v1.14.4/LICENSE):
 
 ```
                                  Apache License
@@ -2964,7 +2964,7 @@ SOFTWARE.
 
 ### @aws-sdk/client-s3
 
-This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.872.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.872.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.872.0/LICENSE):
+This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.896.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.896.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.896.0/LICENSE):
 
 ```
                                 Apache License
@@ -3173,7 +3173,7 @@ This product includes source derived from [@aws-sdk/client-s3](https://github.co
 
 ### @aws-sdk/s3-request-presigner
 
-This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.872.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.872.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.872.0/LICENSE):
+This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.896.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.896.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.896.0/LICENSE):
 
 ```
                                 Apache License
@@ -5033,7 +5033,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ### eslint
 
-This product includes source derived from [eslint](https://github.com/eslint/eslint) ([v9.33.0](https://github.com/eslint/eslint/tree/v9.33.0)), distributed under the [MIT License](https://github.com/eslint/eslint/blob/v9.33.0/LICENSE):
+This product includes source derived from [eslint](https://github.com/eslint/eslint) ([v9.36.0](https://github.com/eslint/eslint/tree/v9.36.0)), distributed under the [MIT License](https://github.com/eslint/eslint/blob/v9.36.0/LICENSE):
 
 ```
 Copyright OpenJS Foundation and other contributors, <www.openjsf.org>

package/esm-loader.mjs

@@ -9,10 +9,10 @@ import subscriptions from './lib/subscriber-configs.js'
 import createSubscriberConfigs from './lib/subscribers/create-config.js'
 // Exclusions must be regexes
 const exclusions = [/@openai\/agents.*/]
-const { packages, instrumentations } = createSubscriberConfigs(subscriptions)
+const { instrumentations } = createSubscriberConfigs(subscriptions)
 
 register('@apm-js-collab/tracing-hooks/hook.mjs', import.meta.url, {
-  data: { instrumentations, packages }
+  data: { instrumentations }
 })
 register('import-in-the-middle/hook.mjs', import.meta.url, {
   data: { exclude: exclusions }

package/lib/attributes.js

@@ -68,7 +68,7 @@ class Attributes {
    * in the list of allowed destinations. If there is a limit on the number of
    * attributes allowed, no more than that number will be included in the result.
    *
-   * @param {AttributeFilter.DESTINATIONS} dest
+   * @param {AttributeFilter.DESTINATIONS} dest - Allowed destinations
    * @returns {object}
    */
   get(dest) {
@@ -92,7 +92,7 @@ class Attributes {
   /**
    * Checks if a given key exists in the instance attributes object.
    *
-   * @param {string} key
+   * @param {string} key the key to check
    */
   has(key) {
     return !!this.attributes[key]
@@ -163,8 +163,8 @@ class Attributes {
    * Returns true if a given key is valid for any of the
    * provided destinations.
    *
-   * @param {DESTINATIONS} destinations
-   * @param {string} key
+   * @param {DESTINATIONS} destinations - The destinations to check against.
+   * @param {string} key the key to check
    */
   hasValidDestination(destinations, key) {
     const validDestinations = this.filter(destinations, key)

package/lib/collector/facts.js

@@ -130,7 +130,7 @@ function getAllIPAddresses() {
  * connections are the same real agent or a separate one.
  * https://github.com/newrelic/node-newrelic/issues/654
  *
- * @param appNames
+ * @param {Array<string>} appNames list of app names
  */
 function getIdentifierOverride(appNames) {
   return [

package/lib/collector/http-agents.js

@@ -19,7 +19,7 @@ let agentProxyWithKeepAlive = null
 /**
  * Returns an HTTP agent with keep-alive enabled
  *
- * @param config
+ * @param {Object} config configuration for HTTP agent
  */
 exports.keepAliveAgent = function keepAliveAgent(config) {
   config = config ? config : {}
@@ -45,7 +45,7 @@ exports.keepAliveAgent = function keepAliveAgent(config) {
  * to the proxy server as to how its connection is made
  * with New Relic's servers.
  *
- * @param config
+ * @param {Object} config configuration for proxy agent
  */
 exports.proxyAgent = function proxyAgent(config) {
   if (agentProxyWithKeepAlive !== null) {

package/lib/collector/parse-response.js

@@ -16,18 +16,15 @@ const logger = require('../logger').child({ component: 'new_relic_response' })
  * about errors as possible, and to parse out the return value as often
  * as possible.
  *
- * @param string         name     Remote method name that was invoked.
- * @param ServerResponse response HTTP response stream
- * @param Function       callback Function that will be called with any
- *                                error, the value returned by the server
- *                                (if any), and the raw JSON of the
- *                                server's response.
- * @param name
- * @param response
- * @param callback
- * @returns Function Another callback that is meant to be invoked with
- *                   any errors from reading the response stream, as
- *                   well as a string containing the full response.
+ * @param {string}         name     Remote method name that was invoked.
+ * @param {ServerResponse} response HTTP response stream
+ * @param {Function}       callback Function that will be called with any
+ *                                  error, the value returned by the server
+ *                                  (if any), and the raw JSON of the
+ *                                  server's response.
+ * @returns {Function} Another callback that is meant to be invoked with
+ *                     any errors from reading the response stream, as
+ *                     well as a string containing the full response.
  */
 module.exports = function parse(name, response, callback) {
   if (!callback) {

package/lib/collector/remote-method.js

@@ -128,9 +128,8 @@ RemoteMethod.prototype.invoke = function invoke(payload, nrHeaders, callback) {
  * Take a serialized payload and create a response wrapper for it before
  * invoking the method on the collector.
  *
- * @param {string}   methodName Name of method to invoke on collector.
  * @param {string}   data       Serialized payload.
- * @param {?object}  nrHeaders  NR request headers from connect response.
+ * @param {object}  nrHeaders  NR request headers from connect response.
  * @param {Function} callback   What to do next. Gets passed any error.
  */
 RemoteMethod.prototype._post = function _post(data, nrHeaders, callback) {
@@ -282,6 +281,7 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
  * Generate the request headers and wire up the request. There are many
  * parameters used to make a request:
  *
+ * @param {object} options options object
  * @param {string}   options.host       Hostname (or proxy hostname) for collector.
  * @param {string}   options.port       Port (or proxy port) for collector.
  * @param {string}   options.path       URL path for method being invoked on collector.
@@ -292,7 +292,6 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
  *                                      original callback given to .send).
  * @param {Function} options.onResponse Response handler for this request (created by
  *                                      ._post).
- * @param options
  */
 RemoteMethod.prototype._request = function _request(options) {
   const requestOptions = {
@@ -364,7 +363,7 @@ RemoteMethod.prototype._path = function _path({ redactLicenseKey } = {}) {
 }
 
 /**
- * @param {object} options
+ * @param {object} options options object
  * @param {number} options.body       - Data to be sent.
  * @param {object} options.nrHeaders  - NR request headers from the connect response.
  * @param {boolean}   options.compressed - The compression method used, if any.
@@ -402,7 +401,7 @@ RemoteMethod.prototype._headers = function _headers(options) {
  *
  * FIXME: come up with a better heuristic
  *
- * @param data
+ * @param {*} data the data that might get compressed
  */
 RemoteMethod.prototype._shouldCompress = function _shouldCompress(data) {
   return data && byteLength(data) > 65536

package/lib/config/formatters.js

@@ -10,7 +10,7 @@ const formatters = module.exports
  * Splits a string by a ',' and trims whitespace
  *
  * @param {string} val config setting
- * @param {Array}
+ * @returns {Array}
  */
 formatters.array = function array(val) {
   return val.split(',').map((k) => k.trim())
@@ -39,8 +39,7 @@ formatters.float = function float(val) {
 /**
  * Parses a config setting as a boolean
  *
- * @param {string} val config setting
- * @param setting
+ * @param {string} setting value of config setting
  * @returns {boolean}
  */
 formatters.boolean = function boolean(setting) {

package/lib/config/index.js

@@ -1529,8 +1529,8 @@ function _laspReponse(keys) {
 /**
  * Applies the server side LASP policies to a local configuration object
  *
- * @param agent
- * @param {object} policies server side LASP policy
+ * @param {Agent} agent Agent instance
+ * @param {bject} policies server side LASP policy
  * @returns {object} { missingRequired, finalPolicies } list of missing required fields and finalized LASP policy
  */
 Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
@@ -1595,7 +1595,7 @@ Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
  * by the agent, if LASP-enabled. Responds with an error to shut down
  * the agent if necessary.
  *
- * @param agent
+ * @param {Agent} agent Agent instance
  * @param {object} policies lasp policy
  * @returns {CollectorResponse} The result of the processing, with the known
  *  policies as the response payload.
@@ -1745,9 +1745,9 @@ Config.prototype._warnDeprecations = function _warnDeprecations() {
  * the environment variables will override their corresponding
  * configuration file settings.
  *
- * @param {object} config Optional configuration to be used in place of a config file.
- * @param root0
- * @param root0.loggerInstance
+ * @param {object} [config] Optional configuration to be used in place of a config file.
+ * @param {object} [deps] Optional dependencies
+ * @param {object} [deps.loggerInstance] Logger instance
  * @returns {object} instantiated configuration object
  */
 function initialize(config, { loggerInstance } = {}) {

package/lib/harvester.js

@@ -74,7 +74,7 @@ module.exports = class Harvester {
   /**
    * Registers an aggregator with the Harvester instance.
    *
-   * @param aggregator
+   * @param {Object} aggregator Aggregator instance
    */
   add(aggregator) {
     this.aggregators.push(aggregator)

package/lib/header-processing.js

@@ -15,8 +15,8 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
  *
- * @param {*} logger
- * @param {*} requestHeaders
+ * @param {Object} logger Logger instance
+ * @param {Object} requestHeaders Incoming request headers
  */
 function getQueueTime(logger, requestHeaders) {
   const headerValue = requestHeaders[REQUEST_START_HEADER] || requestHeaders[QUEUE_HEADER]
@@ -62,7 +62,7 @@ function convertUnit(time) {
  *
  * If no header is found, returns -1
  *
- * @param {*} headers
+ * @param {Object} headers Incoming request headers
  */
 function getContentLengthFromHeaders(headers) {
   const contentLength = -1

package/lib/instrumentation/@node-redis/client.js

@@ -43,7 +43,7 @@ module.exports = function initialize(_agent, redis, _moduleName, shim) {
 /**
  * Instruments a given command when added to the command queue by calling `shim.recordOperation`
  *
- * @param {object} params
+ * @param {object} params params object
  * @param {Shim} params.shim shim instance
  * @param {object} params.commandsQueue instance
  */

package/lib/instrumentation/aws-sdk/v2/instrumentation-helper.js

@@ -7,8 +7,8 @@
 
 /**
  * Series of tests to determine if the library
- * has the features needed to provide instrumentation
- * @param AWS
+ * has the features needed to provide instrumentation.
+ * @param {Object} AWS AWS SDK object
  */
 const instrumentationSupported = function instrumentationSupported(AWS) {
   // instrumentation requires the serviceClientOperationsMap property

package/lib/instrumentation/aws-sdk/v3/common.js

@@ -12,8 +12,8 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Wraps the build middleware step to add the disable DT
  * header to all outgoing requests
  *
- * @param {Shim} shim
- * @param config
+ * @param {Shim} shim instance
+ * @param {Object} config configuration options
  * @param {function} next next function in middleware chain
  * @returns {function}
  *
@@ -31,7 +31,7 @@ function headerMiddleware(shim, config, next) {
  * Wraps the deserialize middleware step to add the
  * appropriate segment attributes for the AWS command
  *
- * @param {Shim} shim
+ * @param {Shim} shim instance
  * @param {Object} config AWS command configuration
  * @param {function} next next function in middleware chain
  * @param {Object} context AWS command context
@@ -55,11 +55,11 @@ function attrMiddleware(shim, config, next, context) {
  * Adds the necessary aws.* attributes to either the External or first
  * class operation segment
  *
- * @param {Object} params
+ * @param {Object} params params object
  * @param {Object} params.result result from middleware
  * @param {Object} params.config AWS config
  * @param {string} params.region AWS region
- * @param {Shim} params.shim
+ * @param {Shim} params.shim Shim instance
  * @param {Object} params.context smithy client context
  */
 function addAwsAttributes({ result, config, region, shim, context }) {

package/lib/instrumentation/aws-sdk/v3/dynamodb.js

@@ -11,7 +11,7 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
 /**
  * Returns the spec for Dynamo commands
  *
- * @param {Shim} shim
+ * @param {Shim} shim Shim instance
  * @param {original} original Original middleware function
  * @param {String} name Name of the calling function
  * @param {Array} args Arguments for the middleware function
@@ -35,7 +35,7 @@ function getDynamoSpec(shim, original, name, args) {
  * unless you provide an endpoint override to your library constructor
  * This function will derive the endpoint in that scenario by grabbing the region
  * and building the URL
- * @param config
+ * @param {Object} config configuration options
  */
 async function getEndpoint(config) {
   if (typeof config.endpoint === 'function') {
@@ -50,7 +50,7 @@ async function getEndpoint(config) {
  * Middleware hook that records the middleware chain
  * when command is in a list of monitored commands.
  *
- * @param {Shim} shim
+ * @param {Shim} shim Shim instance
  * @param {Object} config AWS SDK client configuration
  * @param {function} next middleware function
  * @param {Object} context Context for the running command
@@ -76,7 +76,7 @@ function dynamoMiddleware(shim, config, next, context) {
  * Wraps the deserialize middleware step to add the
  * cloud.resource_id segment attributes for the AWS command
  *
- * @param {Shim} shim
+ * @param {Shim} shim Shim instance
  * @param {Object} config AWS command configuration
  * @param {function} next next function in middleware chain
  * @returns {function}

package/lib/instrumentation/aws-sdk/v3/sns.js

@@ -11,10 +11,10 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Middleware hook that records the middleware chain
  * when command is `PublishCommand`
  *
- * @param {Shim} shim
- * @param config
+ * @param {Shim} shim instance
+ * @param {Object} config configuration options
  * @param {function} next middleware function
- * @param {Object} context
+ * @param {Object} context context
  * @returns {function}
  */
 function snsMiddleware(shim, config, next, context) {
@@ -29,9 +29,9 @@ function snsMiddleware(shim, config, next, context) {
 /**
  * Returns the spec for PublishCommand
  *
- * @param {Shim} shim
- * @param {original} original original middleware function
- * @param name
+ * @param {Shim} shim instance
+ * @param {function} original original middleware function
+ * @param {string} name function name
  * @param {Array} args to the middleware function
  * @returns {Object}
  */
@@ -50,9 +50,9 @@ function getSnsSpec(shim, original, name, args) {
  * Helper to set the appropriate destinationName based on
  * the command input
  *
- * @param root0
- * @param root0.TopicArn
- * @param root0.TargetArn
+ * @param {Object} params params object
+ * @param {string} params.TopicArn TopicArn if available
+ * @param {string} params.TargetArn TargetArn if available
  */
 function getDestinationName({ TopicArn, TargetArn }) {
   return TopicArn || TargetArn || 'PhoneNumber' // We don't want the value of PhoneNumber

package/lib/instrumentation/aws-sdk/v3/sqs.js

@@ -17,10 +17,10 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Middleware hook that records the middleware chain
  * when command is `PublishCommand`
  *
- * @param {Shim} shim
- * @param config
+ * @param {Shim} shim instance
+ * @param {Object} config configuration options
  * @param {function} next middleware function
- * @param {Object} context
+ * @param {Object} context context
  * @returns {function}
  */
 function sqsMiddleware(shim, config, next, context) {
@@ -37,9 +37,9 @@ function sqsMiddleware(shim, config, next, context) {
 /**
  * Returns the spec for PublishCommand
  *
- * @param {Shim} shim
- * @param {original} original original middleware function
- * @param name
+ * @param {Shim} shim instance
+ * @param {function} original original middleware function
+ * @param {string} name function name
  * @param {Array} args to the middleware function
  * @returns {Object}
  */

package/lib/instrumentation/core/http-outbound.js

@@ -289,8 +289,7 @@ function applySegment({ opts, makeRequest, host, port, hostname, segment, config
  * events.
  *
  * @param {Agent} agent New Relic agent
- * @param {string} hostname host of outbound request
- * @param host
+ * @param {string} host host of outbound request
  * @param {TraceSegment} segment outbound http segment
  * @param {http.IncomingMessage} request actual http outbound request
  */

package/lib/instrumentation/fastify/spec-builders.js

@@ -11,7 +11,7 @@ const { MiddlewareSpec } = require('../../shim/specs')
  * Retrieves the IncomingMessage from a Fastify request.  Depending on the
  * context of this function it either exists on `request.raw` or just `request`
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {Function} fn middleware function executing
  * @param {string} fnName name of middleware executing
  * @param {args} args that are passed to middleware
@@ -32,7 +32,7 @@ const getRequestFromFastify = (shim, fn, fnName, args) => {
 /**
  * Retrieves the params from the Fastify request.
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {Function} fn middleware function executing
  * @param {string} fnName name of middleware executing
  * @param {args} args that are passed to middleware
@@ -52,7 +52,7 @@ const getParamsFromFastifyRequest = (shim, fn, fnName, args) => {
  * do its job.  You could also think of it as a
  * mini-DSL
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {string} path URL route being executed
  * @returns {object} spec for Fastify route handler
  */
@@ -78,11 +78,11 @@ function buildMiddlewareSpecForRouteHandler(shim, path) {
      * this particular piece of middleware. (i.e. if this is the final handler
      * that is actually handling the request, the path is actually left on)
      *
-     * @param shim
-     * @param fn
-     * @param fnName
-     * @param args
-     * @param bindSegment
+     * @param {WebFrameworkShim} shim instance
+     * @param {function} fn function
+     * @param {string} fnName function name
+     * @param {Array} args arguments
+     * @param {function} bindSegment the bindSegment function
      */
     next: function wrapNext(shim, fn, fnName, args, bindSegment) {
       const reply = args[1]
@@ -99,11 +99,11 @@ function buildMiddlewareSpecForRouteHandler(shim, path) {
 }
 
 /**
- * Spec for all Fastify middleware(excluding route handlers)
+ * Spec for all Fastify middleware (excluding route handlers)
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {string} name metric name for middleware being executed
- * @param route
+ * @param {number|string|null} route route
  * @returns {object} spec for Fastify middleware
  */
 function buildMiddlewareSpecForMiddlewareFunction(shim, name, route) {

package/lib/instrumentation/fastify.js

@@ -44,8 +44,8 @@ const REQUEST_HOOKS = [
  * at them would require a lot of gymnastics and hard to
  * maintain code
  *
- * @param shim
- * @param fastify
+ * @param {WebFrameworkShim} shim instance
+ * @param {Object} fastify Fastify instance
  */
 const setupRouteHandler = (shim, fastify) => {
   fastify.addHook('onRoute', (routeOptions) => {
@@ -155,8 +155,8 @@ function wrapMiddleware(shim, middleware, name, route) {
  * module.exports.fastify = fastify
  * module.exports.default = fastify
  *
- * @param original
- * @param wrappedExport
+ * @param {Object} original original exports
+ * @param {Object} wrappedExport wrapped exports
  */
 function setupExports(original, wrappedExport) {
   wrappedExport.fastify = original.fastify