refactor: Updated instances in instrumentation of Array.forEach for a more performant for...of or for index loop (#3463)

Author: bizob2828

lib/instrumentation-tracker.js

@@ -211,9 +211,9 @@ class InstrumentationTracker {
       default: {
         // Add the same name to all found instrumentations. This definitely
         // happens when the security agent is enabled.
-        missingResolvedName.forEach((item) => {
+        for (const item of missingResolvedName) {
           item.instrumentation.resolvedName = resolvedName
-        })
+        }
       }
     }
   }

lib/instrumentation/@google/genai.js

@@ -57,7 +57,6 @@ function addLlmMeta({ agent, transaction }) {
  *
  * @param {object} params input params
  * @param {Agent} params.agent NR agent instance
- * @param {Shim} params.shim the current shim instance
  * @param {TraceSegment} params.segment active segment from chat completion
  * @param {object} params.request chat completion params
  * @param {object} params.response chat completion response
@@ -66,7 +65,6 @@ function addLlmMeta({ agent, transaction }) {
  */
 function recordChatCompletionMessages({
   agent,
-  shim,
   segment,
   request,
   response,
@@ -97,20 +95,21 @@ function recordChatCompletionMessages({
   const inputMessages = Array.isArray(request.contents) ? request.contents : [request.contents]
   const responseMessage = response?.candidates?.[0]?.content
   const messages = responseMessage !== undefined ? [...inputMessages, responseMessage] : inputMessages
-  messages.forEach((message, index) => {
+  for (let i = 0; i < messages.length; i++) {
+    const message = messages[i]
     const completionMsg = new LlmChatCompletionMessage({
       agent,
       segment,
       transaction,
       request,
       response,
-      index,
+      index: i,
       completionId: completionSummary.id,
       message
     })
 
     recordEvent({ agent, type: 'LlmChatCompletionMessage', msg: completionMsg })
-  })
+  }
 
   recordEvent({ agent, type: 'LlmChatCompletionSummary', msg: completionSummary })
 
@@ -120,7 +119,7 @@ function recordChatCompletionMessages({
   }
 }
 
-function instrumentStream ({ agent, shim, request, response, segment, transaction }) {
+function instrumentStream ({ shim, request, response, segment, transaction }) {
   let err
   let content
   let modelVersion
@@ -167,7 +166,6 @@ function instrumentStream ({ agent, shim, request, response, segment, transactio
 
           recordChatCompletionMessages({
             agent: shim.agent,
-            shim,
             segment,
             transaction,
             request,
@@ -208,7 +206,6 @@ module.exports = function initialize(agent, googleGenAi, moduleName, shim) {
         after({ error: err, result: response, segment, transaction }) {
           recordChatCompletionMessages({
             agent,
-            shim,
             segment,
             transaction,
             request,
@@ -241,7 +238,7 @@ module.exports = function initialize(agent, googleGenAi, moduleName, shim) {
         name: GEMINI.COMPLETION,
         promise: true,
         after({ result: response, segment, transaction }) {
-          instrumentStream({ agent, shim, request, response, segment, transaction })
+          instrumentStream({ shim, request, response, segment, transaction })
           addLlmMeta({ agent, transaction })
         }
       })

lib/instrumentation/aws-sdk/v3/bedrock.js

@@ -138,7 +138,8 @@ function recordChatCompletionMessages({
 
   // Record context message(s)
   const promptContextMessages = bedrockCommand.prompt
-  promptContextMessages.forEach((contextMessage, promptIndex) => {
+  for (let i = 0; i < promptContextMessages.length; i++) {
+    const contextMessage = promptContextMessages[i]
     const msg = new LlmChatCompletionMessage({
       agent,
       segment,
@@ -147,27 +148,28 @@ function recordChatCompletionMessages({
       content: contextMessage.content,
       role: contextMessage.role,
       bedrockResponse,
-      index: promptIndex,
+      index: i,
       completionId: summary.id
     })
     recordEvent({ agent, type: 'LlmChatCompletionMessage', msg })
-  })
+  }
 
-  bedrockResponse.completions.forEach((content, completionIndex) => {
+  for (let i = 0; i < bedrockResponse.completions.length; i++) {
+    const content = bedrockResponse.completions[i]
     const chatCompletionMessage = new LlmChatCompletionMessage({
       agent,
       segment,
       transaction,
       bedrockCommand,
       bedrockResponse,
       isResponse: true,
-      index: promptContextMessages.length + completionIndex,
+      index: promptContextMessages.length + i,
       content,
       role: 'assistant',
       completionId: summary.id
     })
     recordEvent({ agent, type: 'LlmChatCompletionMessage', msg: chatCompletionMessage })
-  })
+  }
 
   recordEvent({ agent, type: 'LlmChatCompletionSummary', msg: summary })
 
@@ -214,9 +216,9 @@ function recordEmbeddingMessage({
     isError: err !== null
   }))
 
-  embeddings.forEach((embedding) => {
+  for (const embedding of embeddings) {
     recordEvent({ agent, type: 'LlmEmbedding', msg: embedding })
-  })
+  }
 
   if (err) {
     const llmError = new LlmError({ bedrockResponse, err, embedding: embeddings.length === 1 ? embeddings[0] : undefined })

lib/instrumentation/bunyan.js

@@ -38,11 +38,7 @@ function augmentLogData(originalLog, agent, nameFromLevel) {
 
   // Add the metadata to the object being logged
   const metadata = agent.getLinkingMetadata(true)
-  Object.keys(metadata).forEach((m) => {
-    newLog[m] = metadata[m]
-  })
-
-  return newLog
+  return Object.assign({}, newLog, metadata)
 }
 
 function createLoggerWrapper(shim, fn, fnName, bunyanLogger, nameFromLevel) {

lib/instrumentation/core/child_process.js

@@ -56,12 +56,12 @@ function initialize(agent, childProcess, moduleName, shim) {
 
 function makePromisifyCompatible(shim, childProcess) {
   const originalExec = shim.getOriginal(childProcess.exec)
-  Object.getOwnPropertySymbols(originalExec).forEach((symbol) => {
+  for (const symbol of Object.getOwnPropertySymbols(originalExec)) {
     childProcess.exec[symbol] = originalExec[symbol]
-  })
+  }
 
   const originalExecFile = shim.getOriginal(childProcess.execFile)
-  Object.getOwnPropertySymbols(originalExecFile).forEach((symbol) => {
+  for (const symbol of Object.getOwnPropertySymbols(originalExecFile)) {
     childProcess.execFile[symbol] = originalExecFile[symbol]
-  })
+  }
 }

lib/instrumentation/core/fs.js

@@ -55,9 +55,9 @@ function initialize(agent, fs, moduleName, shim) {
   shim.record(fs, methods, recordFs)
 
   const originalExists = shim.getOriginal(fs.exists)
-  Object.getOwnPropertySymbols(originalExists).forEach((symbol) => {
+  for (const symbol of Object.getOwnPropertySymbols(originalExists)) {
     fs.exists[symbol] = originalExists[symbol]
-  })
+  }
 
   fs.realpath.native = shim.getOriginal(fs.realpath).native
 

lib/instrumentation/core/timers.js

@@ -22,7 +22,7 @@ function initialize(_agent, timers, _moduleName, shim) {
  * @param {Array<Timers,global>} pkgs array with references to timers and global
  */
 function instrumentTimerMethods(shim, pkgs) {
-  pkgs.forEach((nodule) => {
+  for (const nodule of pkgs) {
     if (shim.isWrapped(nodule.setTimeout)) {
       return
     }
@@ -31,7 +31,7 @@ function instrumentTimerMethods(shim, pkgs) {
     shim.record(nodule, asynchronizers, recordAsynchronizers)
     shim.wrap(nodule, 'clearTimeout', wrapClearTimeout)
     makeWrappedPromisifyCompatible(shim, nodule)
-  })
+  }
 }
 
 /**
@@ -86,7 +86,7 @@ function makeWrappedPromisifyCompatible(shim, nodule) {
  */
 function copySymbols(shim, nodule, name) {
   const originalFunction = shim.getOriginal(nodule[name])
-  Object.getOwnPropertySymbols(originalFunction).forEach((symbol) => {
+  for (const symbol of Object.getOwnPropertySymbols(originalFunction)) {
     nodule[name][symbol] = originalFunction[symbol]
-  })
+  }
 }

lib/instrumentation/grpc-js/grpc.js

@@ -70,9 +70,9 @@ function wrapStart(shim, original) {
       const outboundAgentHeaders = Object.create(null)
       if (shim.agent.config.distributed_tracing.enabled) {
         transaction.insertDistributedTraceHeaders(outboundAgentHeaders)
-        Object.keys(outboundAgentHeaders).forEach((key) => {
-          nrMetadata.add(key, outboundAgentHeaders[key])
-        })
+        for (const [key, value] of Object.entries(outboundAgentHeaders)) {
+          nrMetadata.add(key, value)
+        }
       } else {
         shim.logger.debug('Distributed tracing disabled by instrumentation.')
       }
@@ -192,9 +192,9 @@ function wrapRegister(shim, original) {
 
     function acceptDTHeaders(stream, transaction) {
       const metadata = stream.metadata
-      Object.entries(metadata.getMap()).forEach(([key, value]) => {
+      for (const [key, value] of Object.entries(metadata.getMap())) {
         transaction.trace.attributes.addAttribute(DESTINATION, `request.headers.${key}`, value)
-      })
+      }
 
       const headers = Object.create(null)
       headers.tracestate = metadata.get('tracestate').join(',')

lib/instrumentation/koa/route-instrumentation.js

@@ -11,23 +11,21 @@ const { MiddlewareSpec } = require('../../shim/specs')
 module.exports = function instrumentRoute(shim, route) {
   shim.setFramework(shim.KOA)
 
-  METHODS.forEach(function wrap(method) {
-    shim.wrap(route, method, function wrapMethod(shim, methodFn) {
-      return function wrappedMethod() {
-        const middleware = methodFn.apply(route, arguments)
-        return shim.recordMiddleware(
-          middleware,
-          new MiddlewareSpec({
-            route: arguments[0],
-            next: shim.LAST,
-            name: shim.getName(arguments[1]),
-            promise: true,
-            req: function getReq(shim, fn, fnName, args) {
-              return args[0] && args[0].req
-            }
-          })
-        )
-      }
-    })
+  shim.wrap(route, METHODS, function wrapMethod(shim, methodFn) {
+    return function wrappedMethod() {
+      const middleware = methodFn.apply(route, arguments)
+      return shim.recordMiddleware(
+        middleware,
+        new MiddlewareSpec({
+          route: arguments[0],
+          next: shim.LAST,
+          name: shim.getName(arguments[1]),
+          promise: true,
+          req: function getReq(shim, fn, fnName, args) {
+            return args[0] && args[0].req
+          }
+        })
+      )
+    }
   })
 }

lib/instrumentation/langchain/vectorstore.js

@@ -52,7 +52,8 @@ function recordVectorSearch({
 
   recordEvent({ agent, shim, type: 'LlmVectorSearch', pkgVersion, msg: vectorSearch })
 
-  output.forEach((document, sequence) => {
+  for (let sequence = 0; sequence < output.length; sequence++) {
+    const document = output[sequence]
     const vectorSearchResult = new LangChainVectorSearchResult({
       agent,
       segment,
@@ -70,7 +71,7 @@ function recordVectorSearch({
       pkgVersion,
       msg: vectorSearchResult
     })
-  })
+  }
 
   if (err) {
     agent.errors.add(