newrelic 8.13.1 → 8.14.1

package/NEWS.md

@@ -1,35 +1,57 @@
-### v8.13.1 (2022-05-27)
+### v8.14.1 (2022-06-09)
 
-* Fixed passing undefined as a formatter options to `winston.format.combine`
+* Added defensive code in redis v4 instrumentation to check for `opts.socket` first before evaluating `opts.socket.path`.
+  Thanks @RAshidAZ for your contribution!
 
-### v8.13.0 (2022-05-26)
+* Updated `@grpc/proto-loader` to v0.6.13 to pickup security fixes in protobufjs.
 
-* Moved log forwarding logic to a transport so customer transports are not polluted with NR linking metadata and timestamp and error manipulations.
+### v8.14.0 (2022-06-06)
 
-* Prevented transmitting logs when application level logging has been disabled.
+* Fixed issue with `api.getBrowserTimingHeader` optional script unwrapping issue with util.format.
+  Thanks for your contribution @github-dd-nicolas 🎉
 
-### v8.12.0 (2022-05-24)
+* Fixed winston instrumentation to not exit early when `winston.createLogger` is created without options.
 
-* Added instrumentation to pino to support application logging use cases: forwarding, local decorating, and metrics.
+* Updated pino instrumentation to not override user log configurations.
 
-* Added supportability metrics about the data usage bytes of harvested data to the collector endpoints.
+### v8.13.2 (2022-05-31)
 
-* Added an optional way to avoid wrapping browser agent script with <script> tag when using `api.getBrowserTimingHeader`.  This will ease usage with Component based libraries like React.
-
-  Thanks to @github-dd-nicolas for the contribution. 🎉
-
-* Upgraded `@grpc/proto-loader` to fix a [CVE](https://security.snyk.io/vuln/SNYK-JS-PROTOBUFJS-2441248) with `protobufjs`.
-
-* Upgraded `@newrelic/test-utilities` to resolve a dev-only audit warning.
-
-### v8.11.2 (2022-05-23)
-
-* Fixed winston instrumentation to no longer coerce every log line to be json.
-
-### v8.11.1 (2022-05-13)
-
-* Fixed an issue with winston instrumentation that caused agent to crash when creating a winston logger from an existing instantiated logger.
+* Upgraded `protobufjs` to resolve  CVE-2022-25878
 
+### v8.13.1 (2022-05-27)
+
+* Fixed passing undefined as a formatter options to `winston.format.combine`
+
+  Thanks to Rana Mohammad (@rjmohammad) for the contribution. 🎉
+
+### v8.13.0 (2022-05-26)
+
+* Moved log forwarding logic to a transport so customer transports are not polluted with NR linking metadata and timestamp and error manipulations.
+
+* Prevented transmitting logs when application level logging has been disabled.
+
+### v8.12.0 (2022-05-24)
+
+* Added instrumentation to pino to support application logging use cases: forwarding, local decorating, and metrics.
+
+* Added supportability metrics about the data usage bytes of harvested data to the collector endpoints.
+
+* Added an optional way to avoid wrapping browser agent script with <script> tag when using `api.getBrowserTimingHeader`.  This will ease usage with Component based libraries like React.
+
+  Thanks to @github-dd-nicolas for the contribution. 🎉
+
+* Upgraded `@grpc/proto-loader` to fix a [CVE](https://security.snyk.io/vuln/SNYK-JS-PROTOBUFJS-2441248) with `protobufjs`.
+
+* Upgraded `@newrelic/test-utilities` to resolve a dev-only audit warning.
+
+### v8.11.2 (2022-05-23)
+
+* Fixed winston instrumentation to no longer coerce every log line to be json.
+
+### v8.11.1 (2022-05-13)
+
+* Fixed an issue with winston instrumentation that caused agent to crash when creating a winston logger from an existing instantiated logger.
+
 ### v8.11.0 (2022-05-11)
 
 * Added application logging for Winston in the Node.js agent

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/instrumentation/@grpc/grpc-js.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright 2022 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+module.exports = function instrument(/* agent, grpc, moduleName, shim */) {
+  // TODO
+}

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/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': { type: MODULE_TYPE.GENERIC },
     '@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.1",
+  "version": "8.14.1",
   "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",