newrelic 8.13.2 → 8.15.0

package/THIRD_PARTY_NOTICES.md

@@ -296,7 +296,7 @@ This product includes source derived from [@grpc/grpc-js](https://github.com/grp
 
 ### @grpc/proto-loader
 
-This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.6.12](https://github.com/grpc/grpc-node/tree/v0.6.12)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.6.12/LICENSE):
+This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.6.13](https://github.com/grpc/grpc-node/tree/v0.6.13)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.6.13/LICENSE):
 
 ```
                                  Apache License
@@ -1801,7 +1801,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.4](https://github.com/newrelic/node-test-utilities/tree/v6.5.4)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.4/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.5](https://github.com/newrelic/node-test-utilities/tree/v6.5.5)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.5/LICENSE):
 
 ```
                                  Apache License

package/api.js

@@ -27,8 +27,9 @@ const NAMES = require('./lib/metrics/names')
  * CONSTANTS
  *
  */
-const RUM_STUB = 'window.NREUM||(NREUM={});NREUM.info = %s;'
-const RUM_STUB_SHELL = `<script type='text/javascript' %s>${RUM_STUB} %s</script>`
+const RUM_STUB = 'window.NREUM||(NREUM={});NREUM.info = %s; %s'
+const RUM_STUB_SHELL = `<script type='text/javascript'>${RUM_STUB}</script>`
+const RUM_STUB_SHELL_WITH_NONCE_PARAM = `<script type='text/javascript' %s>${RUM_STUB}</script>`
 
 // these messages are used in the _gracefail() method below in getBrowserTimingHeader
 const RUM_ISSUES = [
@@ -653,12 +654,18 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
   const tabs = config.browser_monitoring.debug ? 2 : 0
   const json = JSON.stringify(rumHash, null, tabs)
 
-  // set nonce attribute if passed in options
-  const nonce = options && options.nonce ? 'nonce="' + options.nonce + '"' : ''
-  const script = options && options.hasToRemoveScriptWrapper ? RUM_STUB : RUM_STUB_SHELL
-
   // the complete header to be written to the browser
-  const out = util.format(script, nonce, json, jsAgentLoader)
+  const out =
+    options && options.hasToRemoveScriptWrapper
+      ? util.format(RUM_STUB, json, jsAgentLoader)
+      : options && options.nonce
+      ? util.format(
+          RUM_STUB_SHELL_WITH_NONCE_PARAM,
+          'nonce="' + options.nonce + '"',
+          json,
+          jsAgentLoader
+        )
+      : util.format(RUM_STUB_SHELL, json, jsAgentLoader)
 
   logger.trace('generating RUM header', out)
 

package/lib/aggregators/log-aggregator.js

@@ -38,12 +38,12 @@ class LogAggregator extends EventAggregator {
 
     /**
      *  Due to logging library implementation details
-     *  some log lines are already JSON. We must de-serialize
-     *  so it can be serialized in RemoteMethod. I know, this sucks.
+     *  some "log lines" are a function that formats the
+     *  data accordingly into an Object, I know, this sucks.
      */
     const formattedLogs = logs.map((logLine) => {
-      if (typeof logLine === 'string') {
-        return JSON.parse(logLine)
+      if (typeof logLine === 'function') {
+        return logLine()
       }
 
       return logLine

package/lib/config/default.js

@@ -974,5 +974,14 @@ exports.config = () => ({
        */
       enabled: false
     }
-  }
+  },
+
+  /**
+   * You may want more control over how your agent is configured and want to
+   * disallow the use of New Relic's server-side configuration for agents.
+   * To do so, set this to true.
+   *
+   * @env NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG
+   */
+  ignore_server_configuration: false
 })

package/lib/config/env.js

@@ -180,7 +180,8 @@ const ENV_MAPPING = {
     local_decorating: {
       enabled: 'NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED'
     }
-  }
+  },
+  ignore_server_configuration: 'NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG'
 }
 
 // List of environment values which are comma-delimited lists.
@@ -259,7 +260,8 @@ const BOOLEAN_VARS = new Set([
   'NEW_RELIC_APPLICATION_LOGGING_ENABLED',
   'NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED',
   'NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED',
-  'NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED'
+  'NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED',
+  'NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG'
 ])
 
 const FLOAT_VARS = new Set(['NEW_RELIC_APDEX_T', 'NEW_RELIC_TRACER_THRESHOLD'])

package/lib/config/index.js

@@ -275,9 +275,14 @@ Config.prototype._fromServer = function _fromServer(params, key) {
     case 'messages':
       break
 
-    // *sigh* Xzibit, etc.
+    // per the spec this is the key where all server side configuration values will come from.
     case 'agent_config':
-      this.onConnect(params[key], true)
+      if (this.ignore_server_configuration) {
+        this.logDisabled(params, key)
+      } else {
+        this.onConnect(params[key], true)
+      }
+
       break
 
     // if it's undefined or null, so be it
@@ -1307,15 +1312,6 @@ Config.prototype._canonicalize = function _canonicalize() {
     }
   }
 
-  if (isTruthular(this.ignore_server_configuration)) {
-    logger.warnOnce(
-      'IgnoreServerConfigurationWarning',
-      'The local config setting `ignore_server_configuration` has been deprecated ' +
-        'and removed as of Agent v5. Please review agent documentation or contact ' +
-        'New Relic support.'
-    )
-  }
-
   if (this.license_key) {
     this.license_key = this.license_key.trim()
   }

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

@@ -54,7 +54,7 @@ module.exports = function initialize(agent, redis, moduleName, shim) {
   function getRedisParams(opts) {
     return {
       host: (opts.socket && opts.socket.host) || 'localhost',
-      port_path_or_id: (opts.socket && opts.socket.path) || opts.socket.port || '6379',
+      port_path_or_id: (opts.socket && (opts.socket.path || opts.socket.port)) || '6379',
       database_name: opts.database || 0
     }
   }

package/lib/instrumentation/grpc-js/grpc.js

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const recordExternal = require('../../metrics/recorders/http_external')
+
+module.exports = function instrument(shim) {
+  const callStream = shim.require('./build/src/call-stream')
+  shim.wrap(callStream.Http2CallStream.prototype, 'start', (shim, original) => {
+    return function wrappedStart() {
+      const activeSegment = shim.getActiveSegment()
+      if (!activeSegment) {
+        return original.apply(this, arguments)
+      }
+
+      const channel = this.channel
+      const authorityName = (channel.target && channel.target.path) || channel.getDefaultAuthority
+
+      const segment = shim.createSegment({
+        name: `External/${authorityName}${this.methodName}`,
+        opaque: true,
+        recorder: recordExternal(authorityName, 'gRPC')
+      })
+
+      return shim.applySegment(callStart, segment, true, this, arguments)
+
+      function callStart() {
+        const args = shim.argsToArray.apply(shim, arguments)
+
+        const transaction = segment.transaction
+
+        const originalMetadata = args[0]
+        const nrMetadata = originalMetadata.clone()
+
+        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])
+          })
+        } else {
+          shim.logger.debug('Distributed tracing disabled by instrumentation.')
+        }
+
+        args[0] = nrMetadata
+
+        const originalListener = args[1]
+        const nrListener = Object.assign({}, originalListener)
+        nrListener.onReceiveStatus = (status) => {
+          const { code, details } = status
+
+          segment.addAttribute('grpc.statusCode', code)
+          segment.addAttribute('grpc.statusText', details)
+
+          // Java captures client errors based on status code
+          // but has specific gRPC configuration to turn off
+          if (code !== 0) {
+            // this is currently just creating an error from the details string
+            shim.agent.errors.add(segment.transaction, details)
+          }
+
+          segment.addAttribute('component', 'gRPC')
+
+          const protocol = 'grpc'
+
+          const url = `${protocol}://${authorityName}${this.methodName}`
+
+          segment.addAttribute('http.url', url)
+          segment.addAttribute('http.method', this.methodName)
+
+          segment.end()
+
+          originalListener && originalListener.onReceiveStatus(status)
+        }
+
+        args[1] = nrListener
+
+        return original.apply(this, args)
+      }
+    }
+  })
+}

package/lib/instrumentation/grpc-js/nr-hooks.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const grpc = require('./grpc')
+
+/**
+ * Need to use nr-hooks style for grpc because we're using the onResolved hook
+ * to register instrumentation.
+ */
+module.exports = [
+  {
+    type: 'generic',
+    moduleName: '@grpc/grpc-js',
+    onResolved: grpc
+  }
+]

package/lib/instrumentation/pino/pino.js

@@ -49,20 +49,6 @@ module.exports = function instrument(shim) {
 
   const symbols = shim.require('./lib/symbols')
 
-  /**
-   * Wraps the level cache so we can properly set a formatter to return the
-   * label as level in log line instead of number
-   */
-  shim.wrap(levelUtils, 'genLsCache', function genLsCache(shim, genLevelsCache) {
-    return function wrappedGenLsCache() {
-      const args = shim.argsToArray.apply(shim, arguments)
-      args[0][symbols.formattersSym].level = function nrLevelMapping(label) {
-        return { level: label }
-      }
-      return genLevelsCache.apply(this, args)
-    }
-  })
-
   shim.wrap(tools, 'asJson', function wrapJson(shim, asJson) {
     /**
      * Wraps function in pino that is used to construct/serialize a log
@@ -75,27 +61,14 @@ module.exports = function instrument(shim) {
      * @returns {string} serialized log line
      */
     return function wrappedAsJson() {
-      // overriding the symbol that defines the key for message(pino defaults this to `msg`)
-      this[symbols.messageKeySym] = 'message'
-
       const args = shim.argsToArray.apply(shim, arguments)
 
-      /**
-       * changing the label from time to timestamp
-       * and assign unix timestamp to match our specification
-       */
-      args[3] = `,"timestamp":${Date.now()}`
-
       if (isMetricsEnabled(config)) {
         const level = args[2]
         incrementLoggingLinesMetrics(levelMap[level], metrics)
       }
 
-      if (isLogForwardingEnabled(config, agent)) {
-        const metadata = agent.getLinkingMetadata()
-        const chindings = this[symbols.chindingsSym]
-        reformatLogLine(args[0], metadata, chindings)
-      } else if (isLocalDecoratingEnabled(config)) {
+      if (isLocalDecoratingEnabled(config)) {
         args[1] += agent.getNRLinkingMetadata()
       }
 
@@ -107,7 +80,10 @@ module.exports = function instrument(shim) {
       const logLine = asJson.apply(this, args)
 
       if (isLogForwardingEnabled(config, agent)) {
-        agent.logs.add(logLine)
+        const chindings = this[symbols.chindingsSym]
+        const formatLogLine = reformatLogLine({ msg: args[1], logLine, agent, chindings, levelMap })
+
+        agent.logs.add(formatLogLine)
       }
 
       return logLine
@@ -119,14 +95,18 @@ module.exports = function instrument(shim) {
  * reformats error and assigns NR context data
  * to log line
  *
+ * @param logLine.logLine
  * @param {object} logLine log line
  * @param {object} metadata NR context data
  * @param {string} chindings serialized string of all common log line data
+ * @param logLine.args
+ * @param logLine.agent
+ * @param logLine.chindings
+ * @param logLine.msg
+ * @param logLine.levelMap
  */
-function reformatLogLine(logLine, metadata, chindings = '') {
-  if (logLine.err) {
-    reformatError(logLine)
-  }
+function reformatLogLine({ logLine, msg, agent, chindings = '', levelMap }) {
+  const metadata = agent.getLinkingMetadata()
 
   /**
    * pino adds this already for us at times
@@ -137,7 +117,24 @@ function reformatLogLine(logLine, metadata, chindings = '') {
     delete metadata.hostname
   }
 
-  Object.assign(logLine, metadata)
+  const agentMeta = Object.assign({}, { timestamp: Date.now(), message: msg }, metadata)
+
+  /**
+   * A function that gets executed in `_toPayloadSync` of log aggregator.
+   * This will parse the serialized log line and then add the relevant NR
+   * context metadata and rename the time/msg keys to timestamp/message
+   */
+  return function formatLogLine() {
+    const formattedLog = JSON.parse(logLine)
+    if (formattedLog.err) {
+      reformatError(formattedLog)
+    }
+    Object.assign(formattedLog, agentMeta)
+    formattedLog.level = levelMap[formattedLog.level]
+    delete formattedLog.time
+    delete formattedLog.msg
+    return formattedLog
+  }
 }
 
 /**
@@ -150,7 +147,6 @@ function reformatLogLine(logLine, metadata, chindings = '') {
 function reformatError(logLine) {
   logLine['error.message'] = truncate(logLine.err.message)
   logLine['error.stack'] = truncate(logLine.err.stack)
-  logLine['error.class'] =
-    logLine.err.name === 'Error' ? logLine.err.constructor.name : logLine.err.name
+  logLine['error.class'] = logLine.err.type
   delete logLine.err
 }

package/lib/instrumentation/winston.js

@@ -29,8 +29,8 @@ module.exports = function instrument(agent, winston, _, shim) {
   shim.wrap(winston, 'createLogger', function wrapCreate(shim, createLogger) {
     return function createWrappedLogger() {
       const args = shim.argsToArray.apply(shim, arguments)
-      const opts = args[0]
-      if (!shim.isObject(opts) || isStream(opts)) {
+      const opts = args[0] || {}
+      if (isStream(opts)) {
         return createLogger.apply(this, args)
       }
 

package/lib/instrumentations.js

@@ -19,6 +19,7 @@ module.exports = function instrumentations() {
     'express': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'fastify': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'generic-pool': { type: MODULE_TYPE.GENERIC },
+    '@grpc/grpc-js': { module: './instrumentation/grpc-js' },
     '@hapi/hapi': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'hapi': { type: MODULE_TYPE.WEB_FRAMEWORK },
     'ioredis': { type: MODULE_TYPE.DATASTORE },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "8.13.2",
+  "version": "8.15.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -160,7 +160,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.5.5",
-    "@grpc/proto-loader": "^0.6.12",
+    "@grpc/proto-loader": "^0.6.13",
     "@newrelic/aws-sdk": "^4.1.1",
     "@newrelic/koa": "^6.1.1",
     "@newrelic/superagent": "^5.1.0",
@@ -180,7 +180,7 @@
     "@newrelic/eslint-config": "^0.0.3",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
     "@newrelic/proxy": "^2.0.0",
-    "@newrelic/test-utilities": "^6.5.4",
+    "@newrelic/test-utilities": "^6.5.5",
     "@octokit/rest": "^18.0.15",
     "@slack/bolt": "^3.7.0",
     "ajv": "^6.12.6",
@@ -199,7 +199,7 @@
     "express": "*",
     "generic-pool": "^3.6.1",
     "glob": "^7.1.2",
-    "got": "^8.0.1",
+    "got": "^11.8.5",
     "husky": "^6.0.0",
     "jsdoc": "^3.6.3",
     "lint-staged": "^11.0.0",