newrelic 9.11.0 → 9.12.1

package/NEWS.md

@@ -1,18 +1,34 @@
-### v9.11.0 (2023-03-08)
- * Added instrumentation for Prisma(`@prisma/client`).
-   * Miniumum supported version of `@prisma/client` is 4.0.0.
-   * Captures spans for queries. 
+### v9.12.1 (2023-03-15)
+
+* Added ability to mark errors as expected when using `newrelic.noticeError`, by adding an optional boolean: 
+  * `newrelic.noticeError(error, {customAttributes}, true|false)` when there are custom error attributes.
+  * `newrelic.noticeError(error, true|false)` if there are no custom error attributes.
+  * `expected` errors do not affect error metrics or Apdex. 
+
+* Added ability to disable distributed tracing for aws-sdk >= 3.290.0.
+
+* Updated README header image to latest OSS office required images
+  
+* updated @grpc/grpc-js from 1.8.8 to 1.8.9
+
+### v9.12.0 (2023-03-13)
+* Release pipeline did not complete.
+
+### v9.11.0 (2023-03-08)
+ * Added instrumentation for Prisma(`@prisma/client`).
+   * Miniumum supported version of `@prisma/client` is 4.0.0.
+   * Captures spans for queries. 
      * It names them based on the model and action.(i.e. Datastore/statement/Prisma/user/create)
-     * For statements and queries using the `$queryRaw`, `$executeRaw`, `$queryRawUnsafe`, and `$executeRawUnsafe` the names will be aligned with the raw SQL.(i.e. Datastore/statement/Prisma/User/select)
+     * For statements and queries using the `$queryRaw`, `$executeRaw`, `$queryRawUnsafe`, and `$executeRawUnsafe` the names will be aligned with the raw SQL.(i.e. Datastore/statement/Prisma/User/select)
    * Captures database metrics for all statements and queries.
-   * Captures SQL Traces.
+   * Captures SQL Traces.
    * Provides connection between application and database server via service maps. 
-
-Huge shoutout to @osmanmrtacar for the original contribution 🙏🏻
-
- * Updated `@grpc/protoloader` from 0.7.4 to 0.7.5.
- * Updated `@grpc/grpc-js` from 1.8.7 to 1.8.8. 
-
+
+Huge shoutout to @osmanmrtacar for the original contribution 🙏🏻
+
+ * Updated `@grpc/protoloader` from 0.7.4 to 0.7.5.
+ * Updated `@grpc/grpc-js` from 1.8.7 to 1.8.8. 
+
 ### v9.10.2 (2023-02-21)
 
 * Replaced `request.aborted` with `response.close` in HTTP instrumentation.

package/README.md

@@ -1,4 +1,4 @@
-[![Community Plus header](https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+<a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>
 
 # New Relic's Node.js agent
 [![npm status badge][1]][2] [![Server Smoke Tests][3]][4] [![Node Agent CI][5]][6] [![codecov][7]][8]

package/api.js

@@ -403,7 +403,8 @@ API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, valu
  *    } catch (err) {
  *      newrelic.noticeError(
  *        err,
- *        {extraInformation: "error already handled in the application"}
+ *        {extraInformation: "error already handled in the application"},
+ *        true
  *      );
  *    }
  *
@@ -414,12 +415,21 @@ API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, valu
  *  The error to be traced.
  * @param {object} [customAttributes]
  *  Optional. Any custom attributes to be displayed in the New Relic UI.
- * @returns {false|undefined} Retruns false when disabled/errored, otherwise undefined
+ * @param {boolean} expected
+ *  Optional. False by default. True if the error is expected, meaning it should be collected
+ *  for error events and traces, but should not impact error rate.
+ * @returns {false|undefined} Returns false when disabled/errored, otherwise undefined
  */
-API.prototype.noticeError = function noticeError(error, customAttributes) {
+API.prototype.noticeError = function noticeError(error, customAttributes, expected = false) {
   const metric = this.agent.metrics.getOrCreateMetric(NAMES.SUPPORTABILITY.API + '/noticeError')
   metric.incrementCallCount()
 
+  // let users skip the custom attributes if they want
+  if (customAttributes && typeof customAttributes === 'boolean') {
+    expected = customAttributes
+    customAttributes = null
+  }
+
   if (!this.agent.config.api.notice_error_enabled) {
     logger.debug('Config.api.notice_error_enabled set to false, not collecting error')
     return false
@@ -446,7 +456,7 @@ API.prototype.noticeError = function noticeError(error, customAttributes) {
   }
 
   const transaction = this.agent.tracer.getTransaction()
-  this.agent.errors.addUserError(transaction, error, filteredAttributes)
+  this.agent.errors.addUserError(transaction, error, filteredAttributes, expected)
 }
 
 /**

package/lib/errors/error-collector.js

@@ -114,19 +114,27 @@ class ErrorCollector {
    *
    * @param {Transaction} transaction the collected exception's transaction
    * @param {number} collectedErrors the number of errors we've successfully .collect()-ed
-   * @returns {number} the new number of errors successfully .collect()-ed
+   * @param {number} expectedErrors the number of errors marked as expected in noticeError
+   * @returns {Array.<number>} the updated [collectedErrors, expectedErrors] numbers post-processing
    */
-  _processUserErrors(transaction, collectedErrors) {
+  _processUserErrors(transaction, collectedErrors, expectedErrors) {
     if (transaction.userErrors.length) {
       for (let i = 0; i < transaction.userErrors.length; i++) {
         const exception = transaction.userErrors[i]
         if (this.collect(transaction, exception)) {
           ++collectedErrors
+          // if we could collect it, then check if expected
+          if (
+            urltils.isExpectedError(this.config, transaction.statusCode) ||
+            errorHelper.isExpectedException(transaction, exception, this.config, urltils)
+          ) {
+            ++expectedErrors
+          }
         }
       }
     }
 
-    return collectedErrors
+    return [collectedErrors, expectedErrors]
   }
 
   /**
@@ -145,7 +153,7 @@ class ErrorCollector {
         // if we could collect it, then check if expected
         if (
           urltils.isExpectedError(this.config, transaction.statusCode) ||
-          errorHelper.isExpectedException(transaction, exception.error, this.config, urltils)
+          errorHelper.isExpectedException(transaction, exception, this.config, urltils)
         ) {
           ++expectedErrors
         }
@@ -196,7 +204,11 @@ class ErrorCollector {
 
     // errors from noticeError are currently exempt from
     // ignore and exclude rules
-    collectedErrors = this._processUserErrors(transaction, collectedErrors)
+    ;[collectedErrors, expectedErrors] = this._processUserErrors(
+      transaction,
+      collectedErrors,
+      expectedErrors
+    )
 
     const isErroredTransaction = urltils.isError(this.config, transaction.statusCode)
     const isIgnoredErrorStatusCode = urltils.isIgnoredError(this.config, transaction.statusCode)
@@ -276,8 +288,9 @@ class ErrorCollector {
    * @param {?Transaction}  transaction  Transaction associated with the error.
    * @param {*} error The error passed into `API#noticeError()`
    * @param {object} customAttributes custom attributes to add to the error
+   * @param {boolean} expected Is the error expected?
    */
-  addUserError(transaction, error, customAttributes) {
+  addUserError(transaction, error, customAttributes, expected) {
     if (!error) {
       return
     }
@@ -289,7 +302,7 @@ class ErrorCollector {
     }
 
     const timestamp = Date.now()
-    const exception = new Exception({ error, timestamp, customAttributes })
+    const exception = new Exception({ error, timestamp, customAttributes, expected })
 
     if (transaction) {
       transaction.addUserError(exception)

package/lib/errors/helper.js

@@ -34,10 +34,18 @@ module.exports = {
     )
   },
   isExpectedException: function isExpectedException(transaction, exception, config, urltils) {
-    const { type, message } = this.extractErrorInformation(transaction, exception, config, urltils)
+    // this is getting JUST the exception.error
+    const { type, message } = this.extractErrorInformation(
+      transaction,
+      exception.error,
+      config,
+      urltils
+    )
 
     return (
-      this.isExpectedErrorClass(config, type) || this.isExpectedErrorMessage(config, type, message)
+      exception._expected ||
+      this.isExpectedErrorClass(config, type) ||
+      this.isExpectedErrorMessage(config, type, message)
     )
   },
 

package/lib/errors/index.js

@@ -19,11 +19,12 @@ const Transaction = require('../transaction')
 const ERROR_EXPECTED_PATH = 'error.expected'
 
 class Exception {
-  constructor({ error, timestamp, customAttributes, agentAttributes }) {
+  constructor({ error, timestamp, customAttributes, agentAttributes, expected }) {
     this.error = error
     this.timestamp = timestamp || 0
     this.customAttributes = customAttributes || {}
     this.agentAttributes = agentAttributes || {}
+    this._expected = expected
   }
 
   getErrorDetails(config) {
@@ -34,7 +35,7 @@ class Exception {
   }
 
   isExpected(config, { type, message }) {
-    if (!this._expected) {
+    if (typeof this._expected === 'undefined') {
       this._expected =
         errorHelper.isExpectedErrorClass(config, type) ||
         errorHelper.isExpectedErrorMessage(config, type, message)
@@ -103,13 +104,8 @@ function createError(transaction, exception, config) {
 
   params.stack_trace = maybeAddStackTrace(exception, config)
 
-  params.intrinsics[ERROR_EXPECTED_PATH] = errorHelper.isExpected(
-    type,
-    message,
-    transaction,
-    config,
-    urltils
-  )
+  params.intrinsics[ERROR_EXPECTED_PATH] =
+    exception._expected || errorHelper.isExpected(type, message, transaction, config, urltils)
 
   return [0, name, message, type, params]
 }

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

@@ -143,7 +143,7 @@ function instrumentRequest(agent, opts, makeRequest, hostname, segment) {
     outboundHeaders[NEWRELIC_SYNTHETICS_HEADER] = transaction.syntheticsHeader
   }
 
-  maybeAddDtCatHeaders(agent, transaction, outboundHeaders, !!opts?.headers?.[symbols.disableDT])
+  maybeAddDtCatHeaders(agent, transaction, outboundHeaders, opts?.headers)
   opts.headers = assignOutgoingHeaders(opts.headers, outboundHeaders)
 
   const request = applySegment(opts, makeRequest, hostname, segment)
@@ -160,13 +160,18 @@ function instrumentRequest(agent, opts, makeRequest, hostname, segment) {
  * @param {Agent} agent Node.js agent
  * @param {Transaction} transaction active transaction
  * @param {object} outboundHeaders headers that are getting attached to external http call
- * @param {boolean} hasDtSym flag to tell if the disableDT header exists on headers
+ * @param {object} headers headers for http request
  */
 // TODO: abstract header logic shared with TransactionShim#insertCATRequestHeaders
-function maybeAddDtCatHeaders(agent, transaction, outboundHeaders, hasDtSym = false) {
+function maybeAddDtCatHeaders(agent, transaction, outboundHeaders, headers = {}) {
   if (agent.config.distributed_tracing.enabled) {
-    if (hasDtSym) {
+    if (!!(headers[symbols.disableDT] || headers['x-new-relic-disable-dt'])) {
       logger.trace('Distributed tracing disabled by instrumentation.')
+      // we do not need to remove symbol as it will get implicitly removed
+      // when the request is serialized. in fact removing the symbol will cause
+      // the same issue that we had to change this to a string header
+      // see: https://github.com/newrelic/node-newrelic-aws-sdk/issues/168
+      delete headers['x-new-relic-disable-dt']
     } else {
       transaction.insertDistributedTraceHeaders(outboundHeaders)
     }

package/lib/transaction/index.js

@@ -860,7 +860,7 @@ Transaction.prototype.hasOnlyExpectedErrors = function hasOnlyExpectedErrors() {
     const exception = this.exceptions[i]
     // this exception is neither expected nor ignored
     const isUnexpected = !(
-      errorHelper.isExpectedException(this, exception.error, this.agent.config, urltils) ||
+      errorHelper.isExpectedException(this, exception, this.agent.config, urltils) ||
       errorHelper.shouldIgnoreError(this, exception.error, this.agent.config)
     )
     if (isUnexpected) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.11.0",
+  "version": "9.12.1",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -179,7 +179,7 @@
     "newrelic-naming-rules": "./bin/test-naming-rules.js"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.8.8",
+    "@grpc/grpc-js": "^1.8.9",
     "@grpc/proto-loader": "^0.7.5",
     "@newrelic/aws-sdk": "^5.0.2",
     "@newrelic/koa": "^7.1.1",