newrelic 9.15.0 → 10.1.0

package/NEWS.md

@@ -1,23 +1,81 @@
-### v9.15.0 (2023-04-04)
+### v10.1.0 (2023-05-04)
 
-* Added a new configuration option `heroku.use_dyno_names` to specify whether or not to use `process.env.DYNO` for naming the host name and display host.  This option defaults to true.  If you are on heroku and do not want this functionality set `heroku.use_dyno_names` to `false`.  You can also control this configuration options with the environment variable of `NEW_RELIC_HEROKU_USE_DYNO_NAMES`. Thanks @benney-au-le  for your contribution 🚀
+* Added batching and compression to infinite tracing.
+   * These options are on by default. 
+   * To restore uncompressed spans set `config.infinite_tracing.compression` to `false`.
+   * To send single spans vs batches set `config.infinite_tracing.batching` to `false`.
+   * The environment variables for these new configurations are: `NEW_RELIC_INFINITE_TRACING_BATCHING` and `NEW_RELIC_INFINITE_TRACING_COMPRESSION`.
 
-### v9.14.1 (2023-03-23)
+* Added support to record Nest.js error stack traces.
+  * Nest.js is officially supported via underlying instrumentation of express or fastify.
 
-* Restored assigning loaded version of agent to require.cache as `__NR_cache` instead of a symbol to properly detect attempts at loading agent twice.
+* Added job to create a release notes PR in the post-release workflow.
 
-### v9.14.0 (2023-03-23)
+* Removed request library and updated helper to use http/https to make requests in tests.
 
-* Added new API function called `setErrorGroupCallback`, which provides a way for you to customize the `error.group.name` attribute of errors that are captured by the agent. This attribute controls how the Errors Inbox functionality groups similar errors together. To learn more about this function, please refer to our [example app](https://github.com/newrelic/newrelic-node-examples).
-
-### v9.13.0 (2023-03-20)
-
-* Updated http instrumentation to no longer remove the `x-new-relic-disable-dt` header when using AWS SDK v3.  This was done to prevent the "The request signature we calculated does not match the signature you provided. Check your key and signing method." error from AWS SDK.
-
-* Added an API method `setUserID` to provide an ability to associate a unique identifier with a transaction event, transaction trace and errors within transaction.  The attribute will be `enduser.id`.
-
-* Added default configuration for security agent.
+* Reduced cognitive complexity in lib/serverless/aws-lambda.js
 
+### v10.0.0 (2023-04-19)
+
+* **BREAKING** - Updated the default of `config.transaction_tracer.record_sql` from `off` to `obfuscated`. This means that sql statements will be captured but obfuscated.
+
+* **BREAKING** - Route (URL) parameters are now stored as `request.parameters.route.*` attributes on Transactions, root Segments and Spans.
+
+    After this change, the following becomes true:
+
+    - Query parameters will be available as attributes prefixed with request.parameters.* on Transactions and Spans.
+
+    - Route parameters will be available as attributes prefixed with request.parameters.route.* on Transactions and Spans.
+
+    - Route parameters (aka url parameters) are a common feature of various web frameworks, where you can create a placeholder as part of an API route definition.
+
+    For example, given the following Express route definition and request url:
+
+    ```js
+    app.get('/api/users/:id', myMiddleware, myController)
+    ```
+
+    ```sh
+    curl http://localhost:3000/api/users/abc123?id=true
+    ```
+
+    The route parameter is `id`, and has a value of `abc123`. This would become `request.parameters.route.id: abc123` on the Transaction, root Segment, and Span attributes. This example also has a query parameter of `id`, which has a value of true. This would become `request.parameters.id: true` on the Transaction, root Segment, and Span attributes.
+
+* **BREAKING** - Removed `captureUrlParams` from `WebFrameworkShim` class.
+  
+* **DEPRECATION NOTICE**: `shim.unwrap` and `shim.unwrapOnce` will no longer function if you attempt to unwrap an item that has been wrapped multiple times.
+    * This is because since we now allow instrumenting the same module more than once, you cannot safely unwrap without breaking all registered instrumentation.  We plan to remove `shim.unwrap` and `shim.unwrapOnce` in the next major release.
+
+* Added the ability to register instrumentation multiple hooks (onRequire, onResolved) for the same resolved moduleName.
+    * This has been a limitation of the agent from the beginning.  
+    * If you used the api to instrument `api.instrument`, `api.instrumentDatastore`, `api.instrumentWebframework`, `api.instrumentMessages`, or `api.instrumentConglomerate`, it would override existing instrumentation hooks.  The effect was that the Node.js agent would not function as designed.  
+
+* Refactored lib/transaction/tracecontext.js to reduce cognitive complexity.
+
+* Refactored lib/transaction/trace/index.js to reduce cognitive complexity.
+
+* Upgraded devDependencies jsdoc, and lean-jsdoc-theme. 
+
+### v9.15.0 (2023-04-04)
+
+* Added a new configuration option `heroku.use_dyno_names` to specify whether or not to use `process.env.DYNO` for naming the host name and display host.  This option defaults to true.  If you are on heroku and do not want this functionality set `heroku.use_dyno_names` to `false`.  You can also control this configuration options with the environment variable of `NEW_RELIC_HEROKU_USE_DYNO_NAMES`. Thanks @benney-au-le  for your contribution 🚀
+
+### v9.14.1 (2023-03-23)
+
+* Restored assigning loaded version of agent to require.cache as `__NR_cache` instead of a symbol to properly detect attempts at loading agent twice.
+
+### v9.14.0 (2023-03-23)
+
+* Added new API function called `setErrorGroupCallback`, which provides a way for you to customize the `error.group.name` attribute of errors that are captured by the agent. This attribute controls how the Errors Inbox functionality groups similar errors together. To learn more about this function, please refer to our [example app](https://github.com/newrelic/newrelic-node-examples).
+
+### v9.13.0 (2023-03-20)
+
+* Updated http instrumentation to no longer remove the `x-new-relic-disable-dt` header when using AWS SDK v3.  This was done to prevent the "The request signature we calculated does not match the signature you provided. Check your key and signing method." error from AWS SDK.
+
+* Added an API method `setUserID` to provide an ability to associate a unique identifier with a transaction event, transaction trace and errors within transaction.  The attribute will be `enduser.id`.
+
+* Added default configuration for security agent.
+
 ### v9.12.1 (2023-03-15)
 
 * Added ability to mark errors as expected when using `newrelic.noticeError`, by adding an optional boolean: 

package/README.md

@@ -133,9 +133,6 @@ For more information on getting started, [check the Node.js docs](https://docs.n
 There are several modules that can be installed and configured to accompany the Node.js agent:
 
  * [@newrelic/apollo-server-plugin](https://github.com/newrelic/newrelic-node-apollo-server-plugin): New Relic's official Apollo Server plugin for use with the Node.js agent.
- * [@newrelic/winston-enricher](https://github.com/newrelic/newrelic-node-log-extensions/tree/main/packages/winston-log-enricher): Provides distributed trace and span information output as JSON-formatted log messages in Winston.  This is most commonly used with the New Relic Logs product.
- * [@newrelic/pino-enricher](https://github.com/newrelic/newrelic-node-log-extensions/tree/main/packages/pino-log-enricher): Provides distributed trace and span information output as JSON-formatted log messages in Pino.  This is most commonly used with the New Relic Logs product.
- * [@newrelic/mysql](https://github.com/newrelic/node-newrelic-mysql)(**Experimental**): Standalone instrumentation for [mysql2](https://github.com/sidorares/node-mysql2#readme) and [mysql2/promise](https://github.com/sidorares/node-mysql2/blob/master/documentation/Promise-Wrapper.md) as well as the same instrumentation for [mysql](https://github.com/mysqljs/mysql#readme) within the Node.js agent.
  * [@newrelic/next](https://github.com/newrelic/newrelic-node-nextjs): Provides instrumentation for the [Next.js](https://github.com/vercel/next.js/) npm package.
 
 There are several modules included within the Node.js agent to add more instrumentation for 3rd party modules:

package/THIRD_PARTY_NOTICES.md

@@ -62,7 +62,6 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [prettier](#prettier)
 * [proxyquire](#proxyquire)
 * [q](#q)
-* [request](#request)
 * [rimraf](#rimraf)
 * [should](#should)
 * [sinon](#sinon)
@@ -1800,7 +1799,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) ([v7.2.0](https://github.com/newrelic/node-test-utilities/tree/v7.2.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v7.2.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v7.3.0](https://github.com/newrelic/node-test-utilities/tree/v7.3.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v7.3.0/LICENSE):
 
 ```
                                  Apache License
@@ -2177,7 +2176,7 @@ SOFTWARE.
 
 ### clean-jsdoc-theme
 
-This product includes source derived from [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) ([v4.2.4](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/v4.2.4)), distributed under the [MIT License](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/v4.2.4/LICENSE):
+This product includes source derived from [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) ([v4.2.7](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/v4.2.7)), distributed under the [MIT License](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/v4.2.7/LICENSE):
 
 ```
 MIT License
@@ -2709,7 +2708,7 @@ SOFTWARE.
 
 ### jsdoc
 
-This product includes source derived from [jsdoc](https://github.com/jsdoc/jsdoc) ([v4.0.0](https://github.com/jsdoc/jsdoc/tree/v4.0.0)), distributed under the [Apache-2.0 License](https://github.com/jsdoc/jsdoc/blob/v4.0.0/LICENSE.md):
+This product includes source derived from [jsdoc](https://github.com/jsdoc/jsdoc) ([v4.0.2](https://github.com/jsdoc/jsdoc/tree/v4.0.2)), distributed under the [Apache-2.0 License](https://github.com/jsdoc/jsdoc/blob/v4.0.2/LICENSE.md):
 
 ```
 # License
@@ -9165,68 +9164,6 @@ IN THE SOFTWARE.
 
 ```
 
-### request
-
-This product includes source derived from [request](https://github.com/request/request) ([v2.88.2](https://github.com/request/request/tree/v2.88.2)), distributed under the [Apache-2.0 License](https://github.com/request/request/blob/v2.88.2/LICENSE):
-
-```
-Apache License
-
-Version 2.0, January 2004
-
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-
-You must give any other recipients of the Work or Derivative Works a copy of this License; and
-
-You must cause any modified files to carry prominent notices stating that You changed the files; and
-
-You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
-
-If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-```
-
 ### rimraf
 
 This product includes source derived from [rimraf](https://github.com/isaacs/rimraf) ([v2.7.1](https://github.com/isaacs/rimraf/tree/v2.7.1)), distributed under the [ISC License](https://github.com/isaacs/rimraf/blob/v2.7.1/LICENSE):

package/esm-loader.mjs

@@ -68,19 +68,18 @@ export async function resolve(specifier, context, nextResolve) {
 
     if (format === 'commonjs') {
       // ES Modules translate import statements into fully qualified filepaths, so we create a copy of our instrumentation under this filepath
-      const instrumentationDefinitionCopy = Object.assign({}, instrumentationDefinition)
-
-      // Stripping the prefix is necessary because the code downstream gets this url without it
-      instrumentationDefinitionCopy.moduleName = fileURLToPath(url)
-
-      // Added to keep our Supportability metrics from exploding/including customer info via full filepath
-      instrumentationDefinitionCopy.specifier = specifier
-
-      shimmer.registerInstrumentation(instrumentationDefinitionCopy)
-
-      logger.debug(
-        `Registered CommonJS instrumentation for ${specifier} under ${instrumentationDefinitionCopy.moduleName}`
-      )
+      const instrumentationDefinitionCopy = [...instrumentationDefinition]
+      instrumentationDefinitionCopy.forEach((copy) => {
+        // Stripping the prefix is necessary because the code downstream gets this url without it
+        copy.moduleName = fileURLToPath(url)
+
+        // Added to keep our Supportability metrics from exploding/including customer info via full filepath
+        copy.specifier = specifier
+        shimmer.registerInstrumentation(copy)
+        logger.debug(
+          `Registered CommonJS instrumentation for ${specifier} under ${copy.moduleName}`
+        )
+      })
     } else if (format === 'module') {
       registeredSpecifiers.set(url, specifier)
       const modifiedUrl = new URL(url)

package/lib/collector/serverless.js

@@ -23,10 +23,10 @@ class ServerlessCollector {
    * Constructs a new serverless collector instance with the give agent.
    *
    * @class
-   * @param pipePath
    * @classdesc
    *  A helper class for wrapping modules with segments
    * @param {Agent} agent - The agent this collector will use
+   * @param {string} pipePath path of the named pipe to the Lambda extension, if it's enabled
    */
   constructor(agent, pipePath) {
     this._agent = agent
@@ -45,7 +45,7 @@ class ServerlessCollector {
   /**
    * Sets the ARN to be sent up in the metadata.
    *
-   * @param arn
+   * @param {string} arn Amazon Resource Name of the function
    */
   setLambdaArn(arn) {
     this.metadata.arn = arn
@@ -54,7 +54,7 @@ class ServerlessCollector {
   /**
    * Sets the function_version to be sent up in the metadata.
    *
-   * @param function_version
+   * @param {string} function_version version indicator for Lambda function
    */
   setLambdaFunctionVersion(function_version) {
     this.metadata.function_version = function_version
@@ -84,7 +84,7 @@ class ServerlessCollector {
   /**
    * There is nothing to actually restart for serverless, so we do nothing.
    *
-   * @param cb
+   * @param {Function} cb callback function, if any
    */
   restart(cb) {
     setImmediate(cb, null, CollectorResponse.success(null))
@@ -216,6 +216,7 @@ class ServerlessCollector {
    * Constructs, serializes, and prints the final consolidated payload to stdout.
    *
    * @param {Function} cb The callback to invoke when finished.
+   * @returns {boolean} indicating if callback was defined and successfully executed
    */
   flushPayload(cb) {
     if (!this.enabled) {
@@ -270,7 +271,8 @@ class ServerlessCollector {
   /**
    * Writes payload to pipe
    *
-   * @param payload
+   * @param {string} payload serialized stringified-JSON payload to flush
+   * @returns {boolean} whether or not flush was successful
    */
   flushToPipeSync(payload) {
     try {

package/lib/config/default.js

@@ -573,7 +573,7 @@ defaultConfig.definition = () => ({
      */
     record_sql: {
       formatter: allowList.bind(null, ['off', 'obfuscated', 'raw']),
-      default: 'off',
+      default: 'obfuscated',
       env: 'NEW_RELIC_RECORD_SQL'
     },
 
@@ -1122,6 +1122,14 @@ defaultConfig.definition = () => ({
         formatter: int,
         default: 10000
       }
+    },
+    batching: {
+      formatter: boolean,
+      default: true
+    },
+    compression: {
+      formatter: boolean,
+      default: true
     }
   },
   /**

package/lib/grpc/connection.js

@@ -41,15 +41,17 @@ class GrpcConnection extends EventEmitter {
    * Standard property setting/initialization, and sets an initial
    * connection state of disconnected
    *
-   * @param {object} traceObserverConfig config item config.infinite_tracing.trace_observer
+   * @param {object} infiniteTracingConfig config item config.infinite_tracing
    * @param {MetricAggregator} metrics metric aggregator, for supportability metrics
    * @param {number} [reconnectDelayMs=15000] number of milliseconds to wait before reconnecting
    * for error states that require a reconnect delay.
    */
-  constructor(traceObserverConfig, metrics, reconnectDelayMs) {
+  constructor(infiniteTracingConfig, metrics, reconnectDelayMs = DEFAULT_RECONNECT_DELAY_MS) {
     super()
+    this._compression = infiniteTracingConfig.compression
+    this._method = infiniteTracingConfig.batching ? 'recordSpanBatch' : 'recordSpan'
 
-    this._reconnectDelayMs = reconnectDelayMs || DEFAULT_RECONNECT_DELAY_MS
+    this._reconnectDelayMs = reconnectDelayMs
 
     this._metrics = metrics
     this._setState(connectionStates.disconnected)
@@ -58,6 +60,7 @@ class GrpcConnection extends EventEmitter {
     this._runId = null
     this._requestHeadersMap = null
 
+    const traceObserverConfig = infiniteTracingConfig.trace_observer
     this._endpoint = this.getTraceObserverEndpoint(traceObserverConfig)
 
     this._client = null
@@ -70,18 +73,17 @@ class GrpcConnection extends EventEmitter {
    * Allows setting of connection details _after_ object constructions
    * but before the actual connection.
    *
-   * @param {string} endpoint the GRPC server's endpoint
    * @param {string} licenseKey the agent license key
    * @param {string} runId the current agent run id (also called agent run token)
    * @param {object} requestHeadersMap request headers map received from server connect.
    * @param {string} [rootCerts] string of root (ca) certificates to attach to the connection.
+   * @returns {GrpcConnection} the instance of grpc connection
    */
   setConnectionDetails(licenseKey, runId, requestHeadersMap, rootCerts) {
     this._licenseKey = licenseKey
     this._runId = runId
     this._requestHeadersMap = requestHeadersMap
     this._rootCerts = rootCerts
-
     return this
   }
 
@@ -95,9 +97,8 @@ class GrpcConnection extends EventEmitter {
    * Used to indicate a transition from one connection state to
    * the next.  Also responsible for emitting the connect state event
    *
-   * @param {int} state The connection state (See connectionStates above)
-   * @param {ClientDuplexStreamImpl} state The GRPC stream, when defined
-   * @param stream
+   * @param {number} state The connection state (See connectionStates above)
+   * @param {object} stream duplex stream
    */
   _setState(state, stream = null) {
     this._state = state
@@ -145,10 +146,11 @@ class GrpcConnection extends EventEmitter {
   /**
    * Method returns GRPC metadata for initial connection
    *
-   * @param {string} licenseKey
-   * @param {string} runId
-   * @param requestHeadersMap
-   * @param env
+   * @param {string} licenseKey agent key
+   * @param {string} runId agent run id
+   * @param {object} requestHeadersMap map of request headers to include
+   * @param {object} env process.env
+   * @returns {object} grpc metadata
    */
   _getMetadata(licenseKey, runId, requestHeadersMap, env) {
     const metadata = new grpc.Metadata()
@@ -172,8 +174,8 @@ class GrpcConnection extends EventEmitter {
    * Adds test metadata used to simulate connectivity issues
    * when appropriate env vars are set
    *
-   * @param {Metadata} metadata
-   * @param env
+   * @param {object} metadata metadata to set
+   * @param {object} env process.env
    */
   _setTestMetadata(metadata, env) {
     for (const [key, envVar] of Object.entries(GRPC_TEST_META)) {
@@ -236,7 +238,7 @@ class GrpcConnection extends EventEmitter {
    * Events from the GRPC stream (a ClientDuplexStreamImpl) are the main way
    * we communicate with the GRPC server.
    *
-   * @param {ClientDuplexStreamImpl} stream
+   * @param {object} stream duplex stream
    */
   _setupSpanStreamObservers(stream) {
     // Node streams require all data sent by the server to be read before the end
@@ -263,7 +265,7 @@ class GrpcConnection extends EventEmitter {
         // that the versioned Trace Observer is no longer available. Agents
         // MUST NOT attempt to reconnect in this case
         logger.info(
-          '[UNIMPLEMENTED]: Trace Obserserver is no longer available. Shutting down connection.'
+          '[UNIMPLEMENTED]: Trace Observer is no longer available. Shutting down connection.'
         )
         this._disconnect()
       } else if (grpc.status[grpc.status.OK] === grpcStatusName) {
@@ -297,7 +299,8 @@ class GrpcConnection extends EventEmitter {
   /**
    * Creates the GRPC credentials needed
    *
-   * @param grpcApi
+   * @param {object} grpcApi grpc lib
+   * @returns {object} ssl credentials
    */
   _generateCredentials(grpcApi) {
     let certBuffer = null
@@ -325,15 +328,17 @@ class GrpcConnection extends EventEmitter {
    *
    * Contains the actual logic that connects to the GRPC service.
    * "Connection" can be a somewhat misleading term here.  This method
-   * invokes the "recordSpan" remote proceduce call. Behind the scenes
+   * invokes the either `recordSpan` or `recordSpanBatch` remote procedure call. Behind the scenes
    * this makes an http2 request with the metadata, and then returns
    * a stream for further writing.
+   *
+   * @returns {object} stream duplex stream
    */
   _connectSpans() {
     if (!this._client) {
       // Only create once to avoid potential memory leak.
       // We create here (currently) for consistent error handling.
-      this._client = this._createClient(this._endpoint)
+      this._client = this._createClient()
     }
 
     const metadata = this._getMetadata(
@@ -343,7 +348,7 @@ class GrpcConnection extends EventEmitter {
       process.env
     )
 
-    const stream = this._client.recordSpan(metadata)
+    const stream = this._client[this._method](metadata)
     this._setupSpanStreamObservers(stream)
 
     return stream
@@ -357,9 +362,10 @@ class GrpcConnection extends EventEmitter {
    * the stream is closed and we do not have a handle to the client. Currently
    * impacting grpc-js@1.2.11 and several earlier versions.
    *
-   * @param endpoint
+   * @returns {object} protobuf API for IngestService
    */
-  _createClient(endpoint) {
+  _createClient() {
+    const endpoint = this._endpoint
     logger.trace('Creating gRPC client for: ', endpoint)
 
     const packageDefinition = protoLoader.loadSync(PROTO_DEFINITION_PATH, PROTO_OPTIONS)
@@ -369,7 +375,25 @@ class GrpcConnection extends EventEmitter {
     const traceApi = protoDescriptor.com.newrelic.trace.v1
 
     const credentials = this._generateCredentials(grpc)
-    return new traceApi.IngestService(endpoint, credentials)
+
+    // If you want to use mock server use insecure creds
+    // const credentials = grpc.credentials.createInsecure()
+
+    const opts = {}
+    if (this._compression) {
+      // 2 = gzip compression
+      // see: https://github.com/grpc/grpc-node/blob/master/packages/grpc-js/src/compression-algorithms.ts#L21
+      opts['grpc.default_compression_algorithm'] = 2
+      this._metrics
+        .getOrCreateMetric(`${NAMES.INFINITE_TRACING.COMPRESSION}/enabled`)
+        .incrementCallCount()
+    } else {
+      this._metrics
+        .getOrCreateMetric(`${NAMES.INFINITE_TRACING.COMPRESSION}/disabled`)
+        .incrementCallCount()
+    }
+
+    return new traceApi.IngestService(endpoint, credentials, opts)
   }
 }
 

package/lib/grpc/endpoints/infinite-tracing/v1.proto

@@ -6,6 +6,15 @@ service IngestService {
   // Accepts a stream of Span messages, and returns an irregular stream of
   // RecordStatus messages.
   rpc RecordSpan(stream Span) returns (stream RecordStatus) {}
+
+  // Accepts a stream of SpanBatch messages, and returns an irregular
+  // stream of RecordStatus messages. This endpoint can be used to improve
+  // throughput when Span messages are small
+  rpc RecordSpanBatch(stream SpanBatch) returns (stream RecordStatus) {}
+}
+
+message SpanBatch {
+  repeated Span spans = 1;
 }
 
 message Span {
@@ -27,3 +36,4 @@ message AttributeValue {
 message RecordStatus {
   uint64 messages_seen = 1;
 }
+

package/lib/instrumentation/@hapi/vision.js

@@ -20,13 +20,11 @@ module.exports = function initialize(agent, vision, moduleName, shim) {
 
   shim.wrap(plugin, 'register', function wrapRegister(shim, register) {
     return function wrappedRegister(server) {
-      shim.wrap(server, 'decorate', wrapDecorate)
+      if (!shim.isWrapped(server, 'decorate')) {
+        shim.wrap(server, 'decorate', wrapDecorate)
+      }
 
-      const ret = register.apply(this, arguments)
-
-      shim.unwrapOnce(server, 'decorate')
-
-      return ret
+      return register.apply(this, arguments)
     }
   })
 }

package/lib/instrumentation/@nestjs/core.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const logger = require('../../logger').child({ component: 'nestjs' })
+const semver = require('semver')
+
+module.exports = function initialize(agent, core, moduleName, shim) {
+  const nestJsVersion = shim.require('./package.json').version
+  shim.setFramework(shim.NEST)
+  // Earliest version that runs in the tests
+  if (semver.lt(nestJsVersion, '8.0.0')) {
+    logger.debug(
+      `Not instrumenting Nest.js version ${nestJsVersion}; minimum instrumentable version is 8.0.0`
+    )
+    return
+  }
+
+  shim.wrap(core.BaseExceptionFilter.prototype, 'handleUnknownError', (shim, original) => {
+    return function wrappedHandleUnknownError(exception) {
+      const segment = shim.getActiveSegment()
+      const transaction = segment?.transaction
+      if (transaction) {
+        shim.agent.errors.add(transaction, exception)
+        logger.trace(exception, 'Captured error handled by Nest.js exception filter.')
+      } else {
+        logger.trace(
+          exception,
+          'Ignoring error handled by Nest.js exception filter: not in a transaction'
+        )
+      }
+
+      return original.apply(this, arguments)
+    }
+  })
+}