newrelic 13.3.3 → 13.5.0

package/lib/config/index.js

@@ -123,7 +123,8 @@ function Config(config) {
   this.primary_application_id = null
   this.trusted_account_ids = null
   this.trusted_account_key = null
-  this.sampling_target = 10
+
+  this.sampling_target = this.distributed_tracing.sampler.adaptive_sampling_target
   this.sampling_target_period_in_seconds = 60
   this.max_payload_size_in_bytes = DEFAULT_MAX_PAYLOAD_SIZE_IN_BYTES
 
@@ -184,9 +185,9 @@ function Config(config) {
     if (this.security_policies_token) {
       throw new Error(
         'Security Policies and High Security Mode cannot both be present ' +
-          'in the agent configuration. If Security Policies have been set ' +
-          'for your account, please ensure the security_policies_token is ' +
-          'set but high_security is disabled (default).'
+        'in the agent configuration. If Security Policies have been set ' +
+        'for your account, please ensure the security_policies_token is ' +
+        'set but high_security is disabled (default).'
       )
     }
     this._applyHighSecurity()
@@ -199,8 +200,20 @@ function Config(config) {
   this.parsedLabels = parseLabels(this.labels, logger)
   this.loggingLabels = this._setApplicationLoggingLabels()
 }
+
 util.inherits(Config, EventEmitter)
 
+// Expose sampling_target as an accessor that proxies to distributed_tracing.sampler.adaptive_sampling_target.
+Object.defineProperty(Config.prototype, 'sampling_target', {
+  get: function () {
+    return this.distributed_tracing.sampler.adaptive_sampling_target
+  },
+  set: function (value) {
+    this.distributed_tracing.sampler.adaptive_sampling_target = value
+    this.emit('sampling_target', value)
+  }
+})
+
 /**
  * Compares the labels list to the application logging excluded label list and removes any labels that need to be excluded.
  * Then prefixing each label with "tags."
@@ -694,7 +707,7 @@ function _validateThenUpdateStatusCodes(remote, local, remoteKey, localKey) {
     if (!(typeof thingToTest === 'string' || typeof thingToTest === 'number')) {
       logger.warn(
         'Saw SSC (ignore|expect)_status_code that is not a number or string,' +
-          'will not merge: %s',
+        'will not merge: %s',
         thingToTest
       )
       valid = false
@@ -858,7 +871,7 @@ Config.prototype.logDisabled = function logDisabled(json, key) {
   if (value != null) {
     logger.debug(
       'Server-side configuration of %s is currently disabled by local configuration. ' +
-        '(Server sent value of %s.)',
+      '(Server sent value of %s.)',
       key,
       value
     )
@@ -877,7 +890,7 @@ Config.prototype.logUnsupported = function logUnsupported(json, key) {
   if (value !== null && value !== undefined) {
     logger.debug(
       'Server-side configuration of %s is currently not supported by the ' +
-        'Node.js agent. (Server sent value of %s.)',
+      'Node.js agent. (Server sent value of %s.)',
       key,
       value
     )
@@ -1218,8 +1231,8 @@ Config.prototype._serverlessLogging = function _serverlessLogging(inputConfig) {
 
     logger.info(
       'Logging is disabled by default when serverless_mode is enabled. ' +
-        'If desired, enable logging via config file or environment variable and ' +
-        'set filepath to a valid path for current environment, stdout or stderr.'
+      'If desired, enable logging via config file or environment variable and ' +
+      'set filepath to a valid path for current environment, stdout or stderr.'
     )
   }
 }
@@ -1241,17 +1254,17 @@ Config.prototype._serverlessNativeMetrics = function _serverlessNativeMetrics(in
   ) {
     logger.info(
       'Enabling the native-metrics module when in serverless mode may greatly ' +
-        'increase cold-start times. Given the limited benefit of the VM metrics' +
-        'and general lack of control in a serverless environment, we do not ' +
-        'recommend this trade-off.'
+      'increase cold-start times. Given the limited benefit of the VM metrics' +
+      'and general lack of control in a serverless environment, we do not ' +
+      'recommend this trade-off.'
     )
   } else {
     this.plugins.native_metrics.enabled = false
 
     logger.info(
       'The native-metrics module is disabled by default when serverless_mode ' +
-        'is enabled.  If desired, enable the native-metrics module via config file ' +
-        'or environment variable.'
+      'is enabled.  If desired, enable the native-metrics module via config file ' +
+      'or environment variable.'
     )
   }
 }
@@ -1305,8 +1318,8 @@ Config.prototype._serverlessDT = function _serverlessDT() {
     if (this.distributed_tracing.enabled) {
       logger.warn(
         'Using distributed tracing in serverless mode requires account_id be ' +
-          'defined, either in your newrelic.js file or via environment variables. ' +
-          'Disabling distributed tracing.'
+        'defined, either in your newrelic.js file or via environment variables. ' +
+        'Disabling distributed tracing.'
       )
       this.distributed_tracing.enabled = false
     }
@@ -1332,8 +1345,8 @@ Config.prototype._preventServerlessDT = function _preventServerlessDT() {
     if (this[key]) {
       logger.warn(
         key +
-          ' was configured locally without enabling serverless_mode. ' +
-          'This local value will be ignored and set by the New Relic servers.'
+        ' was configured locally without enabling serverless_mode. ' +
+        'This local value will be ignored and set by the New Relic servers.'
       )
       this[key] = null
     }
@@ -1529,7 +1542,7 @@ function _laspReponse(keys) {
 /**
  * Applies the server side LASP policies to a local configuration object
  *
- * @param agent
+ * @param {Agent} agent Agent instance
  * @param {object} policies server side LASP policy
  * @returns {object} { missingRequired, finalPolicies } list of missing required fields and finalized LASP policy
  */
@@ -1595,7 +1608,7 @@ Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
  * by the agent, if LASP-enabled. Responds with an error to shut down
  * the agent if necessary.
  *
- * @param agent
+ * @param {Agent} agent Agent instance
  * @param {object} policies lasp policy
  * @returns {CollectorResponse} The result of the processing, with the known
  *  policies as the response payload.
@@ -1670,7 +1683,7 @@ function redactValue(value) {
  * Get a JSONifiable object containing all settings we want to report to the
  * collector and store in the environment_values table.
  *
- * @returns {object} containing simple key-value pairs of settings
+ * @returns {object|undefined} containing simple key-value pairs of settings, or undefined if an error occurred
  */
 Config.prototype.publicSettings = function publicSettings() {
   let settings = Object.create(null)
@@ -1745,9 +1758,9 @@ Config.prototype._warnDeprecations = function _warnDeprecations() {
  * the environment variables will override their corresponding
  * configuration file settings.
  *
- * @param {object} config Optional configuration to be used in place of a config file.
- * @param root0
- * @param root0.loggerInstance
+ * @param {object} [config] Optional configuration to be used in place of a config file.
+ * @param {object} [deps] Optional dependencies
+ * @param {object} [deps.loggerInstance] Logger instance
  * @returns {object} instantiated configuration object
  */
 function initialize(config, { loggerInstance } = {}) {

package/lib/harvester.js

@@ -74,7 +74,7 @@ module.exports = class Harvester {
   /**
    * Registers an aggregator with the Harvester instance.
    *
-   * @param aggregator
+   * @param {object} aggregator Aggregator instance
    */
   add(aggregator) {
     this.aggregators.push(aggregator)

package/lib/header-processing.js

@@ -15,8 +15,8 @@ const CONTENT_LENGTH_REGEX = /^Content-Length$/i
  * Queue time is provided by certain providers by stamping the request
  * header with the time the request arrived at the router.
  *
- * @param {*} logger
- * @param {*} requestHeaders
+ * @param {object} logger Logger instance
+ * @param {object} requestHeaders Incoming request headers
  */
 function getQueueTime(logger, requestHeaders) {
   const headerValue = requestHeaders[REQUEST_START_HEADER] || requestHeaders[QUEUE_HEADER]
@@ -62,7 +62,7 @@ function convertUnit(time) {
  *
  * If no header is found, returns -1
  *
- * @param {*} headers
+ * @param {object} headers Incoming request headers
  */
 function getContentLengthFromHeaders(headers) {
   const contentLength = -1

package/lib/health-reporter.js

@@ -112,7 +112,7 @@ class HealthReporter {
    * object that has an `agent_control` property which is an instance of
    * {@link AgentControlConfig}.
    * @param {object} [params.logger] A standard logger instance.
-   * @param {function} [params.setInterval] A function to use as `setInterval`.
+   * @param {Function} [params.setInterval] A function to use as `setInterval`.
    * Must return an interval object that supports the `unref()` method.
    */
   constructor({
@@ -217,7 +217,7 @@ class HealthReporter {
    * initiate an immediate write of the status file, and then invoke the
    * provided callback.
    *
-   * @param {function} done Callback to be invoked after the status file has
+   * @param {Function} done Callback to be invoked after the status file has
    * been updated.
    */
   stop(done) {

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

@@ -43,7 +43,7 @@ module.exports = function initialize(_agent, redis, _moduleName, shim) {
 /**
  * Instruments a given command when added to the command queue by calling `shim.recordOperation`
  *
- * @param {object} params
+ * @param {object} params params object
  * @param {Shim} params.shim shim instance
  * @param {object} params.commandsQueue instance
  */

package/lib/instrumentation/@prisma/client.js

@@ -75,7 +75,7 @@ function extractQueryArgs(args, pkgVersion) {
  *
  * @param {Array} args arguments to a prisma operation
  * @param {string} pkgVersion prisma version
- * @returns {string} query raw query string or model call <collection>.<operation>
+ * @returns {string|undefined} query raw query string or model call <collection>.<operation>
  */
 function retrieveQuery(args, pkgVersion) {
   if (Array.isArray(args)) {

package/lib/instrumentation/aws-sdk/util.js

@@ -20,9 +20,9 @@ function grabLastUrlSegment(url = '/') {
 /**
  * Retrieves the db segment params from endpoint and command parameters
  *
- * @param {Object} endpoint instance of ddb endpoint
- * @param {Object} params parameters passed to a ddb command
- * @returns {Object}
+ * @param {object} endpoint instance of ddb endpoint
+ * @param {object} params parameters passed to a ddb command
+ * @returns {object}
  */
 function setDynamoParameters(endpoint, params) {
   return new DatastoreParameters({

package/lib/instrumentation/aws-sdk/v2/instrumentation-helper.js

@@ -7,8 +7,8 @@
 
 /**
  * Series of tests to determine if the library
- * has the features needed to provide instrumentation
- * @param AWS
+ * has the features needed to provide instrumentation.
+ * @param {object} AWS AWS SDK object
  */
 const instrumentationSupported = function instrumentationSupported(AWS) {
   // instrumentation requires the serviceClientOperationsMap property

package/lib/instrumentation/aws-sdk/v3/bedrock.js

@@ -43,7 +43,7 @@ const CONVERSE_COMMANDS = new Set([
 /**
  * Helper to determine if we should instrument the bedrock middleware call
  *
- * @param {Object} config agent configuration
+ * @param {object} config agent configuration
  * @returns {boolean} to instrument or not to instrument
  */
 function shouldSkipInstrumentation(config) {
@@ -251,9 +251,9 @@ function createBedrockResponse({ bedrockCommand, response, err }) {
  * @param {object} params { config, commandName } aws config and command name
  * @param {string} params.commandName name of command
  * @param {Shim} shim instance of shim
- * @param {function} _original original middleware function
+ * @param {Function} _original original middleware function
  * @param {string} _name function name
- * @param {array} args argument passed to middleware
+ * @param {Array} args argument passed to middleware
  * @returns {object} specification object that records middleware as promise
  * with an after hook to create LLM events
  */
@@ -357,10 +357,10 @@ function handleResponse({ shim, err, response, segment, transaction, bedrockComm
  *
  * @param {Shim} shim instance of shim
  * @param {object} config AWS configuration object
- * @param {function} next the next middleware function in stack
+ * @param {Function} next the next middleware function in stack
  * @param {object} context AWS client context info
  *
- * @returns {function} the next middleware function in stack
+ * @returns {Function} the next middleware function in stack
  */
 function bedrockMiddleware(shim, config, next, context) {
   const { commandName } = context

package/lib/instrumentation/aws-sdk/v3/common.js

@@ -12,10 +12,10 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Wraps the build middleware step to add the disable DT
  * header to all outgoing requests
  *
- * @param {Shim} shim
- * @param config
- * @param {function} next next function in middleware chain
- * @returns {function}
+ * @param {Shim} shim instance
+ * @param {object} config configuration options
+ * @param {Function} next next function in middleware chain
+ * @returns {Function}
  *
  */
 function headerMiddleware(shim, config, next) {
@@ -31,11 +31,11 @@ function headerMiddleware(shim, config, next) {
  * Wraps the deserialize middleware step to add the
  * appropriate segment attributes for the AWS command
  *
- * @param {Shim} shim
- * @param {Object} config AWS command configuration
- * @param {function} next next function in middleware chain
- * @param {Object} context AWS command context
- * @returns {function}
+ * @param {Shim} shim instance
+ * @param {object} config AWS command configuration
+ * @param {Function} next next function in middleware chain
+ * @param {object} context AWS command context
+ * @returns {Function}
  */
 function attrMiddleware(shim, config, next, context) {
   return async function wrappedMiddleware(args) {
@@ -55,12 +55,12 @@ function attrMiddleware(shim, config, next, context) {
  * Adds the necessary aws.* attributes to either the External or first
  * class operation segment
  *
- * @param {Object} params
- * @param {Object} params.result result from middleware
- * @param {Object} params.config AWS config
+ * @param {object} params params object
+ * @param {object} params.result result from middleware
+ * @param {object} params.config AWS config
  * @param {string} params.region AWS region
- * @param {Shim} params.shim
- * @param {Object} params.context smithy client context
+ * @param {Shim} params.shim Shim instance
+ * @param {object} params.context smithy client context
  */
 function addAwsAttributes({ result, config, region, shim, context }) {
   try {

package/lib/instrumentation/aws-sdk/v3/dynamodb.js

@@ -11,11 +11,11 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
 /**
  * Returns the spec for Dynamo commands
  *
- * @param {Shim} shim
+ * @param {Shim} shim Shim instance
  * @param {original} original Original middleware function
- * @param {String} name Name of the calling function
+ * @param {string} name Name of the calling function
  * @param {Array} args Arguments for the middleware function
- * @returns {Object}
+ * @returns {object}
  */
 function getDynamoSpec(shim, original, name, args) {
   const [{ input }] = args
@@ -35,7 +35,7 @@ function getDynamoSpec(shim, original, name, args) {
  * unless you provide an endpoint override to your library constructor
  * This function will derive the endpoint in that scenario by grabbing the region
  * and building the URL
- * @param config
+ * @param {object} config configuration options
  */
 async function getEndpoint(config) {
   if (typeof config.endpoint === 'function') {
@@ -50,11 +50,11 @@ async function getEndpoint(config) {
  * Middleware hook that records the middleware chain
  * when command is in a list of monitored commands.
  *
- * @param {Shim} shim
- * @param {Object} config AWS SDK client configuration
- * @param {function} next middleware function
- * @param {Object} context Context for the running command
- * @returns {function}
+ * @param {Shim} shim Shim instance
+ * @param {object} config AWS SDK client configuration
+ * @param {Function} next middleware function
+ * @param {object} context Context for the running command
+ * @returns {Function}
  */
 function dynamoMiddleware(shim, config, next, context) {
   const { commandName } = context
@@ -76,10 +76,10 @@ function dynamoMiddleware(shim, config, next, context) {
  * Wraps the deserialize middleware step to add the
  * cloud.resource_id segment attributes for the AWS command
  *
- * @param {Shim} shim
- * @param {Object} config AWS command configuration
- * @param {function} next next function in middleware chain
- * @returns {function}
+ * @param {Shim} shim Shim instance
+ * @param {object} config AWS command configuration
+ * @param {Function} next next function in middleware chain
+ * @returns {Function}
  */
 function resourceIdMiddlerware(shim, config, next) {
   return async function wrappedResourceIdMiddlerware(args) {

package/lib/instrumentation/aws-sdk/v3/lambda.js

@@ -11,9 +11,9 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * cloud.resource_id segment attributes for the AWS command
  *
  * @param {Shim} shim New Relic agent shim
- * @param {Object} config AWS command configuration
- * @param {function} next next function in middleware chain
- * @returns {function} wrapped version of middleware function
+ * @param {object} config AWS command configuration
+ * @param {Function} next next function in middleware chain
+ * @returns {Function} wrapped version of middleware function
  */
 function resourceIdMiddleware(shim, config, next) {
   return async function wrappedResourceIdMiddleware(args) {

package/lib/instrumentation/aws-sdk/v3/sns.js

@@ -11,11 +11,11 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Middleware hook that records the middleware chain
  * when command is `PublishCommand`
  *
- * @param {Shim} shim
- * @param config
- * @param {function} next middleware function
- * @param {Object} context
- * @returns {function}
+ * @param {Shim} shim instance
+ * @param {object} config configuration options
+ * @param {Function} next middleware function
+ * @param {object} context context
+ * @returns {Function}
  */
 function snsMiddleware(shim, config, next, context) {
   if (context.commandName === 'PublishCommand') {
@@ -29,11 +29,11 @@ function snsMiddleware(shim, config, next, context) {
 /**
  * Returns the spec for PublishCommand
  *
- * @param {Shim} shim
- * @param {original} original original middleware function
- * @param name
+ * @param {Shim} shim instance
+ * @param {Function} original original middleware function
+ * @param {string} name function name
  * @param {Array} args to the middleware function
- * @returns {Object}
+ * @returns {object}
  */
 function getSnsSpec(shim, original, name, args) {
   const [command] = args
@@ -50,9 +50,9 @@ function getSnsSpec(shim, original, name, args) {
  * Helper to set the appropriate destinationName based on
  * the command input
  *
- * @param root0
- * @param root0.TopicArn
- * @param root0.TargetArn
+ * @param {object} params params object
+ * @param {string} params.TopicArn TopicArn if available
+ * @param {string} params.TargetArn TargetArn if available
  */
 function getDestinationName({ TopicArn, TargetArn }) {
   return TopicArn || TargetArn || 'PhoneNumber' // We don't want the value of PhoneNumber

package/lib/instrumentation/aws-sdk/v3/sqs.js

@@ -17,11 +17,11 @@ const InstrumentationDescriptor = require('../../../instrumentation-descriptor')
  * Middleware hook that records the middleware chain
  * when command is `PublishCommand`
  *
- * @param {Shim} shim
- * @param config
- * @param {function} next middleware function
- * @param {Object} context
- * @returns {function}
+ * @param {Shim} shim instance
+ * @param {object} config configuration options
+ * @param {Function} next middleware function
+ * @param {object} context context
+ * @returns {Function}
  */
 function sqsMiddleware(shim, config, next, context) {
   if (SEND_COMMANDS.includes(context.commandName)) {
@@ -37,11 +37,11 @@ function sqsMiddleware(shim, config, next, context) {
 /**
  * Returns the spec for PublishCommand
  *
- * @param {Shim} shim
- * @param {original} original original middleware function
- * @param name
+ * @param {Shim} shim instance
+ * @param {Function} original original middleware function
+ * @param {string} name function name
  * @param {Array} args to the middleware function
- * @returns {Object}
+ * @returns {object}
  */
 function getSqsSpec(shim, original, name, args) {
   const [command] = args

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

@@ -289,8 +289,7 @@ function applySegment({ opts, makeRequest, host, port, hostname, segment, config
  * events.
  *
  * @param {Agent} agent New Relic agent
- * @param {string} hostname host of outbound request
- * @param host
+ * @param {string} host host of outbound request
  * @param {TraceSegment} segment outbound http segment
  * @param {http.IncomingMessage} request actual http outbound request
  */

package/lib/instrumentation/fastify/spec-builders.js

@@ -11,7 +11,7 @@ const { MiddlewareSpec } = require('../../shim/specs')
  * Retrieves the IncomingMessage from a Fastify request.  Depending on the
  * context of this function it either exists on `request.raw` or just `request`
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {Function} fn middleware function executing
  * @param {string} fnName name of middleware executing
  * @param {args} args that are passed to middleware
@@ -32,7 +32,7 @@ const getRequestFromFastify = (shim, fn, fnName, args) => {
 /**
  * Retrieves the params from the Fastify request.
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {Function} fn middleware function executing
  * @param {string} fnName name of middleware executing
  * @param {args} args that are passed to middleware
@@ -52,7 +52,7 @@ const getParamsFromFastifyRequest = (shim, fn, fnName, args) => {
  * do its job.  You could also think of it as a
  * mini-DSL
  *
- * @param {WebFrameworkShim} shim
+ * @param {WebFrameworkShim} shim instance
  * @param {string} path URL route being executed
  * @returns {object} spec for Fastify route handler
  */
@@ -78,11 +78,11 @@ function buildMiddlewareSpecForRouteHandler(shim, path) {
      * this particular piece of middleware. (i.e. if this is the final handler
      * that is actually handling the request, the path is actually left on)
      *
-     * @param shim
-     * @param fn
-     * @param fnName
-     * @param args
-     * @param bindSegment
+     * @param {WebFrameworkShim} shim instance
+     * @param {Function} fn function
+     * @param {string} fnName function name
+     * @param {Array} args arguments
+     * @param {Function} bindSegment the bindSegment function
      */
     next: function wrapNext(shim, fn, fnName, args, bindSegment) {
       const reply = args[1]
@@ -98,26 +98,6 @@ function buildMiddlewareSpecForRouteHandler(shim, path) {
   })
 }
 
-/**
- * Spec for all Fastify middleware(excluding route handlers)
- *
- * @param {WebFrameworkShim} shim
- * @param {string} name metric name for middleware being executed
- * @param route
- * @returns {object} spec for Fastify middleware
- */
-function buildMiddlewareSpecForMiddlewareFunction(shim, name, route) {
-  return new MiddlewareSpec({
-    name,
-    route,
-    next: shim.LAST,
-    params: getParamsFromFastifyRequest,
-    req: getRequestFromFastify,
-    type: shim.MIDDLEWARE
-  })
-}
-
 module.exports = {
-  buildMiddlewareSpecForRouteHandler,
-  buildMiddlewareSpecForMiddlewareFunction
+  buildMiddlewareSpecForRouteHandler
 }