newrelic 9.7.2 → 9.7.3

package/NEWS.md

@@ -1,7 +1,11 @@
-### v9.7.2 (2022-12-07)
-
-* Updated `@grpc/grpc-js` instrumentation to work with 1.8.0.
-
+### v9.7.3 (2022-12-12)
+
+* Added support for Code Level Metrics on API methods: `startSegment`, `startBackgroundTransaction`, and `startWebTransaction`.
+
+### v9.7.2 (2022-12-07)
+
+* Updated `@grpc/grpc-js` instrumentation to work with 1.8.0.
+
 ### v9.7.1 (2022-12-06)
 
 * Reintroduced throttling during reading of instrumented application's dependency tree during startup, to prevent EMFILE issues.

package/THIRD_PARTY_NOTICES.md

@@ -54,6 +54,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [husky](#husky)
 * [jsdoc](#jsdoc)
 * [lint-staged](#lint-staged)
+* [lockfile-lint](#lockfile-lint)
 * [memcached](#memcached)
 * [minami](#minami)
 * [nock](#nock)
@@ -2787,6 +2788,204 @@ SOFTWARE.
 
 ```
 
+### lockfile-lint
+
+This product includes source derived from [lockfile-lint](https://github.com/lirantal/lockfile-lint) ([v4.9.6](https://github.com/lirantal/lockfile-lint/tree/v4.9.6)), distributed under the [Apache-2.0 License](https://github.com/lirantal/lockfile-lint/blob/v4.9.6/LICENSE):
+
+```
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) 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
+
+      (d) 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
+
+   Copyright 2019 Liran Tal <liran.tal@gmail.com>.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
+
 ### memcached
 
 This product includes source derived from [memcached](https://github.com/3rd-Eden/node-memcached) ([v2.2.2](https://github.com/3rd-Eden/node-memcached/tree/v2.2.2)), distributed under the [MIT License](https://github.com/3rd-Eden/node-memcached/blob/v2.2.2/LICENSE):

package/api.js

@@ -19,10 +19,15 @@ const TransactionShim = require('./lib/shim/transaction-shim')
 const TransactionHandle = require('./lib/transaction/handle')
 const AwsLambda = require('./lib/serverless/aws-lambda')
 const applicationLogging = require('./lib/util/application-logging')
+const {
+  assignCLMSymbol,
+  addCLMAttributes: maybeAddCLMAttributes
+} = require('./lib/util/code-level-metrics')
 
 const ATTR_DEST = require('./lib/config/attribute-filter').DESTINATIONS
 const MODULE_TYPE = require('./lib/shim/constants').MODULE_TYPE
 const NAMES = require('./lib/metrics/names')
+
 /*
  *
  * CONSTANTS
@@ -840,6 +845,7 @@ API.prototype.startSegment = function startSegment(name, record, handler, callba
     return handler(callback)
   }
 
+  assignCLMSymbol(this.shim, handler)
   // Create the segment and call the handler.
   const wrappedHandler = this.shim.record(handler, function handlerNamer(shim) {
     return {
@@ -901,6 +907,7 @@ API.prototype.startWebTransaction = function startWebTransaction(url, handle) {
   const tracer = this.agent.tracer
   const parent = tracer.getTransaction()
 
+  assignCLMSymbol(shim, handle)
   return tracer.transactionNestProxy('web', function startWebSegment() {
     const tx = tracer.getTransaction()
 
@@ -926,6 +933,7 @@ API.prototype.startWebTransaction = function startWebTransaction(url, handle) {
     tx.baseSegment.start()
 
     const boundHandle = tracer.bindFunction(handle, tx.baseSegment)
+    maybeAddCLMAttributes(handle, tx.baseSegment)
     let returnResult = boundHandle.call(this)
     if (returnResult && shim.isPromise(returnResult)) {
       returnResult = shim.interceptPromise(returnResult, tx.end.bind(tx))
@@ -999,6 +1007,7 @@ function startBackgroundTransaction(name, group, handle) {
   const txName = group + '/' + name
   const parent = tracer.getTransaction()
 
+  assignCLMSymbol(shim, handle)
   return tracer.transactionNestProxy('bg', function startBackgroundSegment() {
     const tx = tracer.getTransaction()
 
@@ -1025,6 +1034,7 @@ function startBackgroundTransaction(name, group, handle) {
     tx.baseSegment.start()
 
     const boundHandle = tracer.bindFunction(handle, tx.baseSegment)
+    maybeAddCLMAttributes(handle, tx.baseSegment)
     let returnResult = boundHandle.call(this)
     if (returnResult && shim.isPromise(returnResult)) {
       returnResult = shim.interceptPromise(returnResult, tx.end.bind(tx))

package/lib/shim/shim.js

@@ -14,7 +14,7 @@ const path = require('path')
 const specs = require('./specs')
 const util = require('util')
 const symbols = require('../symbols')
-const maybeAddCLMAttributes = require('../util/code-level-metrics')
+const { addCLMAttributes: maybeAddCLMAttributes } = require('../util/code-level-metrics')
 
 // Some modules do terrible things, like change the prototype of functions. To
 // avoid crashing things we'll use a cached copy of apply everywhere.

package/lib/shim/webframework-shim.js

@@ -16,6 +16,7 @@ const specs = require('./specs')
 const urltils = require('../util/urltils')
 const util = require('util')
 const symbols = require('../symbols')
+const { assignCLMSymbol } = require('../util/code-level-metrics')
 
 /**
  * An enumeration of well-known web frameworks so that new instrumentations can
@@ -677,23 +678,6 @@ function _defaultResponsePredicate() {
   return false
 }
 
-/**
- * Attaches a flag on function indicating that
- * CLM attributes need to be associated with the middleware
- * span during record
- *
- * Note: director middleware instrumentation passes in a string as the "function" so we have to check if the middleware is actually a function
- * to avoid crashing.
- *
- * @param {Shim} shim instance of shim
- * @param {Function} middleware function to apply clm symbol
- */
-function assignCLMSymbol(shim, middleware) {
-  if (shim.isFunction(middleware) && shim.agent.config.code_level_metrics.enabled) {
-    middleware[symbols.clm] = true
-  }
-}
-
 /**
  * Wraps the given function in a middleware recorder function.
  *

package/lib/transaction/tracer/index.js

@@ -11,6 +11,7 @@ const symbols = require('../../symbols')
 const INACTIVE_TRANSACTION_MESSAGE = 'Not creating segment "%s" because no transaction was active'
 const SKIP_WRAPPING_FUNCTION_MESSAGE = 'Not wrapping "%s" because it was not a function'
 const CREATE_SEGMENT_MESSAGE = 'Creating "%s" segment for transaction %s.'
+const { addCLMAttributes: maybeAddCLMAttributes } = require('../../util/code-level-metrics')
 
 module.exports = Tracer
 
@@ -85,6 +86,7 @@ function addSegment(name, recorder, parent, full, task) {
 
   const segment = this.createSegment(name, recorder, parent)
 
+  maybeAddCLMAttributes(task, segment)
   return this.bindFunction(task, segment, full)(segment)
 }
 

package/lib/util/code-level-metrics.js

@@ -7,6 +7,23 @@
 const logger = require('../logger').child({ component: 'code-level-metrics' })
 const { isValidLength } = require('./byte-limit')
 const symbols = require('../symbols')
+const clmUtils = module.exports
+
+/**
+ * Attaches a flag on function indicating that
+ * CLM attributes need to be associated with it.
+ *
+ * Note: director middleware instrumentation passes in a string as the "function" so we have to check if the function is actually a function
+ * to avoid crashing, abstraction not FTW
+ *
+ * @param {Shim} shim instance of shim
+ * @param {Function} fn function to apply clm symbol
+ */
+clmUtils.assignCLMSymbol = function assignCLMSymbol(shim, fn) {
+  if (shim.isFunction(fn) && shim.agent.config.code_level_metrics.enabled) {
+    fn[symbols.clm] = true
+  }
+}
 
 /**
  * Uses function name if truthy
@@ -29,7 +46,7 @@ function setFunctionName(name) {
  * @param {Function} fn function reference
  * @param {TraceSegment} segment active segment to attach code.* attrs
  */
-module.exports = function addCLMAttributes(fn, segment) {
+clmUtils.addCLMAttributes = function addCLMAttributes(fn, segment) {
   if (!fn[symbols.clm]) {
     return
   }
@@ -48,7 +65,11 @@ module.exports = function addCLMAttributes(fn, segment) {
       segment.addAttribute('code.column', column + 1)
     }
   } catch (err) {
-    logger.infoOnce({ err }, 'Not using v8 function inspector, falling back to function name')
+    logger.infoOnce(
+      'clm:function-inspector',
+      { err },
+      'Not using v8 function inspector, falling back to function name'
+    )
     const fnName = setFunctionName(fn.name)
 
     if (isValidLength(fnName, 255)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.7.2",
+  "version": "9.7.3",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -151,6 +151,7 @@
     "prepare-test": "npm run ssl && npm run docker-env",
     "lint": "eslint ./*.{js,mjs} lib test bin examples",
     "lint:fix": "eslint --fix, ./*.{js,mjs} lib test bin examples",
+    "lint:lockfile": "lockfile-lint --path package-lock.json --type npm --allowed-hosts npm --validate-https --validate-integrity",
     "public-docs": "jsdoc -c ./jsdoc-conf.json --tutorials examples/shim api.js lib/shim/ lib/transaction/handle.js && cp examples/shim/*.png out/",
     "publish-docs": "./bin/publish-docs.sh",
     "services": "./bin/docker-services.sh",
@@ -192,8 +193,8 @@
     "winston-transport": "^4.5.0"
   },
   "optionalDependencies": {
-    "@newrelic/native-metrics": "^9.0.0",
-    "@contrast/fn-inspect": "^3.3.0"
+    "@contrast/fn-inspect": "^3.3.0",
+    "@newrelic/native-metrics": "^9.0.0"
   },
   "devDependencies": {
     "@newrelic/eslint-config": "^0.2.0",
@@ -221,6 +222,7 @@
     "husky": "^6.0.0",
     "jsdoc": "^3.6.3",
     "lint-staged": "^11.0.0",
+    "lockfile-lint": "^4.9.6",
     "memcached": ">=0.2.8",
     "minami": "^1.2.3",
     "nock": "11.8.0",