newrelic 11.19.0 → 11.20.0

package/NEWS.md

@@ -1,3 +1,37 @@
+### v11.20.0 (2024-06-24)
+
+#### Features
+
+* Added support for Anthropic Claude 3 messages API ([#2278](https://github.com/newrelic/node-newrelic/pull/2278)) ([7e3cab9](https://github.com/newrelic/node-newrelic/commit/7e3cab9739a9924b904ce78380fd70b1e30cd89f))
+
+#### Code refactoring
+
+* Replaced instances of `substr()` with `substring()` ([#2274](https://github.com/newrelic/node-newrelic/pull/2274)) ([8f96c73](https://github.com/newrelic/node-newrelic/commit/8f96c734862d42f459dd4de8ed9d498ef7d693de))
+
+#### Documentation
+
+* Fixed typos in API jsdoc ([#2287](https://github.com/newrelic/node-newrelic/pull/2287)) ([7b3c8d1](https://github.com/newrelic/node-newrelic/commit/7b3c8d1445ea9876b36eda31d979dac9b65dad14))
+* Updated compatibility report ([#2285](https://github.com/newrelic/node-newrelic/pull/2285)) ([b1b5e3e](https://github.com/newrelic/node-newrelic/commit/b1b5e3e54074cc8b535927f4edad07925618260c))
+
+#### Miscellaneous chores
+
+* Added a missing library we instrument to be picked up by the compatibility report ([#2261](https://github.com/newrelic/node-newrelic/pull/2261)) ([6c964b2](https://github.com/newrelic/node-newrelic/commit/6c964b2029874353908486228113a468959b1597))
+* Added a script that generates Dashboard json for reporting on libraries by version ([#2267](https://github.com/newrelic/node-newrelic/pull/2267)) ([d2877c1](https://github.com/newrelic/node-newrelic/commit/d2877c17c7c2f4432b2ce4056c94200a2e7334b2))
+* Added AI support docs for automation ([#2249](https://github.com/newrelic/node-newrelic/pull/2249)) ([e2efc1f](https://github.com/newrelic/node-newrelic/commit/e2efc1fb202a3e87be710f352546a00df6bf6cef))
+* Fixed comment about transaction_tracer.transaction_threshold ([#2258](https://github.com/newrelic/node-newrelic/pull/2258)) ([7cd6aef](https://github.com/newrelic/node-newrelic/commit/7cd6aef7ecc32d8647f0313b36be368bfa14a0e9))
+* Made elastic versioned tests work on Node 16 ([#2284](https://github.com/newrelic/node-newrelic/pull/2284)) ([143b475](https://github.com/newrelic/node-newrelic/commit/143b4757c27d497a25d1b3c7fd56b32bcede619f))
+* Updated docker compose configuration ([#2268](https://github.com/newrelic/node-newrelic/pull/2268)) ([eb1cce9](https://github.com/newrelic/node-newrelic/commit/eb1cce9143fe87eed1bdd077471942f85cf14f21))
+* Updated GitHub Actions versions ([#2272](https://github.com/newrelic/node-newrelic/pull/2272)) ([07a841b](https://github.com/newrelic/node-newrelic/commit/07a841b9acf0a0dcb1a495c5cb0ee8f77e283fc9))
+* Updated mysql tests to use MySQL 8.3 ([#2280](https://github.com/newrelic/node-newrelic/pull/2280)) ([11e0f8c](https://github.com/newrelic/node-newrelic/commit/11e0f8cf63a5f792419382635496a29c0286c737))
+* Updated mysql2 tests to fix CI issue ([#2282](https://github.com/newrelic/node-newrelic/pull/2282)) ([5a37971](https://github.com/newrelic/node-newrelic/commit/5a37971b03fe8d69b39db66d97ecfc1176c42902))
+* Updated versioned security agent workflow with simpler setup ([#2259](https://github.com/newrelic/node-newrelic/pull/2259)) ([a886187](https://github.com/newrelic/node-newrelic/commit/a886187bf1bf29d2430e38223d0215436e006540))
+
+#### Continuous integration
+
+* Added ability to run a build step in create release ([#2273](https://github.com/newrelic/node-newrelic/pull/2273)) ([4c2f24c](https://github.com/newrelic/node-newrelic/commit/4c2f24cb6e94dd05f269998eeb763196c3fac274))
+* Updated security agent workflow to use large runners when available ([#2271](https://github.com/newrelic/node-newrelic/pull/2271)) ([181ec1b](https://github.com/newrelic/node-newrelic/commit/181ec1bfa8d420514fca3d6de6c3989e796a29db))
+* Updated security agent workflow to use large runners when available ([#2270](https://github.com/newrelic/node-newrelic/pull/2270)) ([761fcd5](https://github.com/newrelic/node-newrelic/commit/761fcd5ca5ae32ba922d0880979dbfff97604641))
+
 ### v11.19.0 (2024-06-06)
 
 #### Features

package/api.js

@@ -244,14 +244,14 @@ API.prototype.setControllerName = function setControllerName(name, action) {
 }
 
 /**
- * Add a custom attribute to the current transaction. Some attributes are
+ * Add a custom attribute to the current transaction and span. Some attributes are
  * reserved (see CUSTOM_DENYLIST for the current, very short list), and
  * as with most API methods, this must be called in the context of an
  * active transaction. Most recently set value wins.
  *
  * @param {string} key  The key you want displayed in the RPM UI.
  * @param {string} value The value you want displayed. Must be serializable.
- * @returns {false|undefined} Retruns false when disabled/errored, otherwise undefined
+ * @returns {false|undefined} Returns false when disabled/errored, otherwise undefined
  */
 API.prototype.addCustomAttribute = function addCustomAttribute(key, value) {
   const metric = this.agent.metrics.getOrCreateMetric(
@@ -298,7 +298,7 @@ API.prototype.addCustomAttribute = function addCustomAttribute(key, value) {
 }
 
 /**
- * Adds all custom attributes in an object to the current transaction.
+ * Adds all custom attributes in an object to the current transaction and span.
  *
  * See documentation for newrelic.addCustomAttribute for more information on
  * setting custom attributes.
@@ -360,7 +360,7 @@ API.prototype.addCustomSpanAttributes = function addCustomSpanAttributes(atts) {
  *
  * @param {string} key  The key you want displayed in the RPM UI.
  * @param {string} value The value you want displayed. Must be serializable.
- * @returns {false|undefined} Retruns false when disabled/errored, otherwise undefined
+ * @returns {false|undefined} Returns false when disabled/errored, otherwise undefined
  */
 API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, value) {
   const metric = this.agent.metrics.getOrCreateMetric(
@@ -807,7 +807,7 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options =
      * Only the first 13 chars of the license should be used for hashing with
      * the transaction name.
      */
-    const key = config.license_key.substr(0, 13)
+    const key = config.license_key.substring(0, 13)
     rumHash.transactionName = hashes.obfuscateNameUsingKey(name, key)
 
     rumHash.queueTime = trans.queueTime
@@ -938,7 +938,7 @@ API.prototype.startSegment = function startSegment(name, record, handler, callba
  * })
  * @param {string} url
  *  The URL of the transaction.  It is used to name and group related transactions in APM,
- *  so it should be a generic name and not iclude any variable parameters.
+ *  so it should be a generic name and not include any variable parameters.
  * @param {Function}  handle
  *  Function that represents the transaction work.
  * @returns {null|*} Returns null if handle is not a function, otherwise the return value of handle
@@ -1026,7 +1026,7 @@ API.prototype.startBackgroundTransaction = startBackgroundTransaction
  * })
  * @param {string} name
  *  The name of the transaction. It is used to name and group related
- *  transactions in APM, so it should be a generic name and not iclude any
+ *  transactions in APM, so it should be a generic name and not include any
  *  variable parameters.
  * @param {string} [group]
  *  Optional, used for grouping background transactions in APM. For more
@@ -1297,14 +1297,14 @@ API.prototype.recordCustomEvent = function recordCustomEvent(eventType, attribut
   // Filter all object type valued attributes out
   const filteredAttributes = _filterAttributes(attributes, `${eventType} custom event`)
 
-  const instrinics = {
+  const intrinsics = {
     type: eventType,
     timestamp: Date.now()
   }
 
   const tx = this.agent.getTransaction()
   const priority = (tx && tx.priority) || Math.random()
-  this.agent.customEventAggregator.add([instrinics, filteredAttributes], priority)
+  this.agent.customEventAggregator.add([intrinsics, filteredAttributes], priority)
 }
 
 /**
@@ -1342,7 +1342,7 @@ API.prototype.instrument = function instrument(moduleName, onRequire, onError) {
  * Registers an instrumentation function.
  *
  * - `newrelic.instrumentConglomerate(moduleName, onRequire [, onError])`
- * - `newrelic.isntrumentConglomerate(options)`
+ * - `newrelic.instrumentConglomerate(options)`
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module

package/lib/config/attribute-filter.js

@@ -367,7 +367,7 @@ function _convertRulesToRegex(rules) {
           if (i !== r.length - 1) {
             v += '.'
           } else if (/\\\*$/.test(v)) {
-            v = v.substr(0, v.length - 2)
+            v = v.substring(0, v.length - 2)
           }
 
           const idx = c.findIndex(function findV(a) {

package/lib/config/default.js

@@ -519,12 +519,12 @@ defaultConfig.definition = () => ({
       env: 'NEW_RELIC_TRACER_ENABLED'
     },
     /**
-     * The duration at below which the slow transaction tracer should collect a
-     * transaction trace. If set to 'apdex_f', the threshold will be set to
+     * Sets the time, in seconds, for a transaction to be considered slow.
+     * When a transaction exceeds this threshold, a transaction trace will be recorded. When set to 'apdex_f', the threshold will be set to
      * 4 * apdex_t, which with a default apdex_t value of 500 milliseconds will
      * be 2 seconds.
      *
-     * If a time is provided, it is set in seconds.
+     * If a number is provided, it is set in seconds.
      */
     transaction_threshold: {
       formatter: float,

package/lib/instrumentation/aws-sdk/util.js

@@ -14,7 +14,7 @@ function grabLastUrlSegment(url = '/') {
   // string for null, undefined, NaN etc.
   url = '' + (url || '/')
   const lastSlashIndex = url.lastIndexOf('/')
-  return url.substr(lastSlashIndex + 1)
+  return url.substring(lastSlashIndex + 1)
 }
 
 /**

package/lib/llm-events/aws-bedrock/bedrock-command.js

@@ -35,7 +35,7 @@ class BedrockCommand {
       result = this.#body.maxTokens
     } else if (this.isClaude() === true) {
       result = this.#body.max_tokens_to_sample
-    } else if (this.isCohere() === true) {
+    } else if (this.isClaude3() === true || this.isCohere() === true) {
       result = this.#body.max_tokens
     } else if (this.isLlama2() === true) {
       result = this.#body.max_gen_length
@@ -83,6 +83,11 @@ class BedrockCommand {
       this.isLlama2() === true
     ) {
       result = this.#body.prompt
+    } else if (this.isClaude3() === true) {
+      result = this.#body?.messages?.reduce((acc, curr) => {
+        acc += curr?.content ?? ''
+        return acc
+      }, '')
     }
     return result
   }
@@ -96,6 +101,7 @@ class BedrockCommand {
       result = this.#body.textGenerationConfig?.temperature
     } else if (
       this.isClaude() === true ||
+      this.isClaude3() === true ||
       this.isAi21() === true ||
       this.isCohere() === true ||
       this.isLlama2() === true
@@ -110,7 +116,11 @@ class BedrockCommand {
   }
 
   isClaude() {
-    return this.#modelId.startsWith('anthropic.claude')
+    return this.#modelId.startsWith('anthropic.claude-v')
+  }
+
+  isClaude3() {
+    return this.#modelId.startsWith('anthropic.claude-3')
   }
 
   isCohere() {

package/lib/llm-events/aws-bedrock/bedrock-response.js

@@ -30,10 +30,12 @@ class BedrockResponse {
   #completions = []
   #id
 
+  /* eslint-disable sonarjs/cognitive-complexity */
   /**
    * @param {object} params
    * @param {AwsBedrockMiddlewareResponse} params.response
    * @param {BedrockCommand} params.bedrockCommand
+   * @param params.isError
    */
   constructor({ response, bedrockCommand, isError = false }) {
     this.#innerResponse = isError ? response.$response : response.response
@@ -57,6 +59,14 @@ class BedrockResponse {
     } else if (cmd.isClaude() === true) {
       // TODO: can we make this thing give more than one completion?
       body.completion && this.#completions.push(body.completion)
+    } else if (cmd.isClaude3() === true) {
+      if (body?.type === 'message_stop') {
+        // Streamed response
+        this.#completions = body.completions
+      } else {
+        this.#completions = body?.content?.map((c) => c.text)
+      }
+      this.#id = body.id
     } else if (cmd.isCohere() === true) {
       this.#completions = body.generations?.map((g) => g.text) ?? []
       this.#id = body.id
@@ -66,6 +76,7 @@ class BedrockResponse {
       this.#completions = body.results?.map((r) => r.outputText) ?? []
     }
   }
+  /* eslint-enable sonarjs/cognitive-complexity */
 
   /**
    * The prompt responses returned by the model.
@@ -92,7 +103,7 @@ class BedrockResponse {
     const cmd = this.#command
     if (cmd.isAi21() === true) {
       result = this.#parsedBody.completions?.[0]?.finishReason.reason
-    } else if (cmd.isClaude() === true) {
+    } else if (cmd.isClaude() === true || cmd.isClaude3() === true) {
       result = this.#parsedBody.stop_reason
     } else if (cmd.isCohere() === true) {
       result = this.#parsedBody.generations?.find((r) => r.finish_reason !== null)?.finish_reason

package/lib/llm-events/aws-bedrock/stream-handler.js

@@ -105,6 +105,9 @@ class StreamHandler {
     if (bedrockCommand.isClaude() === true) {
       this.stopReasonKey = 'stop_reason'
       this.generator = handleClaude
+    } else if (bedrockCommand.isClaude3() === true) {
+      this.stopReasonKey = 'stop_reason'
+      this.generator = handleClaude3
     } else if (bedrockCommand.isCohere() === true) {
       this.stopReasonKey = 'generations.0.finish_reason'
       this.generator = handleCohere
@@ -207,6 +210,31 @@ async function* handleClaude() {
   }
 }
 
+async function* handleClaude3() {
+  let currentBody = {}
+  let stopReason
+  const completions = []
+
+  try {
+    for await (const event of this.stream) {
+      yield event
+      const parsed = this.parseEvent(event)
+      this.updateHeaders(parsed)
+      currentBody = parsed
+      if (parsed.type === 'content_block_delta') {
+        completions.push(parsed.delta.text)
+      } else if (parsed.type === 'message_delta') {
+        stopReason = parsed.delta.stop_reason
+      }
+    }
+  } finally {
+    currentBody.completions = completions
+    currentBody.stop_reason = stopReason
+    this.response.output.body = currentBody
+    this.finish()
+  }
+}
+
 async function* handleCohere() {
   let currentBody = {}
   const generations = []

package/lib/shim/datastore-shim.js

@@ -376,10 +376,10 @@ function parseQuery(query, nodule) {
   // strip enclosing special characters from collection (table) name
   if (typeof collection === 'string' && collection.length > 2) {
     if (/^[\[{'"`]/.test(collection)) {
-      collection = collection.substr(1)
+      collection = collection.substring(1)
     }
     if (/[\]}'"`]$/.test(collection)) {
-      collection = collection.substr(0, collection.length - 1)
+      collection = collection.substring(0, collection.length - 1)
     }
   }
 

package/lib/transaction/name-state.js

@@ -187,7 +187,7 @@ NameState.prototype.getPath = function getPath() {
       if (a[0] !== '/' && path[path.length - 1] !== '/') {
         path += '/'
       } else if (a[0] === '/' && path[path.length - 1] === '/') {
-        a = a.substr(1)
+        a = a.substring(1)
       }
       path += a
     }

package/lib/util/hashes.js

@@ -41,7 +41,8 @@ function calculatePathHash(appName, pathName, referingPathHash) {
   const result = (rotated ^ hash) >>> 0
 
   // This is a trick to pad it out to 8 chars regardless of length.
-  return ('00000000' + result.toString(16)).substr(-8)
+  const str = '00000000' + result.toString(16)
+  return str.substring(str.length - 8)
 }
 
 function getHash(appName, txName) {
@@ -78,7 +79,7 @@ function int32ToByteArray(int32) {
 // Lookup table for converting byte values to hex
 const byteToHex = []
 for (let i = 0; i < 256; ++i) {
-  byteToHex[i] = (i + 0x100).toString(16).substr(1)
+  byteToHex[i] = (i + 0x100).toString(16).substring(1)
 }
 
 function makeId(length = 16) {

package/lib/utilization/docker-info.js

@@ -41,7 +41,7 @@ module.exports.getBootId = function getBootId(agent, callback) {
     if (data.length !== 36) {
       bootIdError()
       if (data.length > 128) {
-        data = data.substr(0, 128)
+        data = data.substring(0, 128)
       }
     }
 

package/lib/utilization/gcp-info.js

@@ -54,8 +54,10 @@ function fetchGCPInfo(agent, callback) {
         agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.GCP_ERROR).incrementCallCount()
       } else {
         // normalize
-        results.machineType = results.machineType.substr(results.machineType.lastIndexOf('/') + 1)
-        results.zone = results.zone.substr(results.zone.lastIndexOf('/') + 1)
+        results.machineType = results.machineType.substring(
+          results.machineType.lastIndexOf('/') + 1
+        )
+        results.zone = results.zone.substring(results.zone.lastIndexOf('/') + 1)
 
         resultDict = results
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "11.19.0",
+  "version": "11.20.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -163,7 +163,7 @@
     "lint:fix": "eslint --fix, ./*.{js,mjs} lib test bin examples",
     "public-docs": "jsdoc -c ./jsdoc-conf.jsonc && cp examples/shim/*.png out/",
     "publish-docs": "./bin/publish-docs.sh",
-    "services": "docker compose up -d --wait",
+    "services": "DOCKER_PLATFORM=linux/$(uname -m) docker compose up -d --wait",
     "services:stop": "docker compose down",
     "smoke": "npm run ssl && time tap test/smoke/**/**/*.tap.js --timeout=180 --no-coverage",
     "ssl": "./bin/ssl.sh",