newrelic 13.19.2 → 14.0.0

package/api.js

@@ -1977,4 +1977,89 @@ API.prototype.withLlmCustomAttributes = function withLlmCustomAttributes(context
   return transaction._llmContextManager.run(fullContext, callback)
 }
 
+/**
+ * Function for adding a custom callback to generate custom attributes on apollo server operation segments.
+ *
+ * Provided functions must be synchronous and return an object of custom attribute key/values.
+ * The arguments provided to callback are: `requestContext`, which is the apollo server `requestContext`.
+ *
+ *
+ * @param {Function} callback - callback function to generate custom attributes on apollo operation segments
+ * @example
+ * function customOperationAttributes(requestContext) {
+ *  return {
+ *    clientName: requestContext.request.http.headers.get('graphql-client-name')
+ *  }
+ * }
+ *
+ * newrelic.setApolloOperationAttributesCallback(customOperationAttributes)
+ */
+API.prototype.setApolloOperationAttributesCallback = function setApolloOperationAttributesCallback(callback) {
+  const self = this
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/setApolloOperationAttributesCallback'
+  )
+  metric.incrementCallCount()
+
+  if (!this.shim.isFunction(callback) || this.shim.isAsyncFunction(callback)) {
+    logger.warn(
+      'Apollo operation attributes callback must be a synchronous function, custom operation attributes will not be added.'
+    )
+    return
+  }
+
+  this.agent.customCallbacks.apollo.operationCallback = function wrappedOperationAttributesCb(requestContext) {
+    const result = callback(requestContext)
+    self.addCustomAttributes(result)
+  }
+}
+
+/**
+ * Function for adding a custom callback to generate custom attributes on apollo server resolver segments.
+ *
+ * Provided functions must be synchronous and return an object of custom attribute key/values.
+ * The arguments provided to callback are:
+ *
+ * ```
+ * {
+ *   source: object,
+ *   args: array,
+ *   contextValue: object,
+ *   info: object
+ * }
+ * ```
+ *
+ * @param {Function} callback - callback function to generate custom attributes on apollo operation segments
+ * @example
+ * function customResolverAttributes({ source, args, contextValue, info }}) {
+ *  return {
+ *    allArgs: Object.keys(args).join(','),
+ *    returnType: info.returnType.name,
+ *    sourceBranch: source?.branch
+ *    stage: contextValue.event.requestContext.stage
+ *  }
+ * }
+ *
+ * newrelic.setApolloResolverAttributesCallback(customResolverAttributes)
+ */
+API.prototype.setApolloResolverAttributesCallback = function setApolloResolverAttributesCallback(callback) {
+  const self = this
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/setApolloResolverAttributesCallback'
+  )
+  metric.incrementCallCount()
+
+  if (!this.shim.isFunction(callback) || this.shim.isAsyncFunction(callback)) {
+    logger.warn(
+      'Apollo resolver attributes callback must be a synchronous function, custom resolver attributes will not be added.'
+    )
+    return
+  }
+
+  this.agent.customCallbacks.apollo.resolverCallback = function wrappedResolverAttributesCb(args) {
+    const result = callback(args)
+    self.addCustomAttributes(result)
+  }
+}
+
 module.exports = API

package/lib/agent.js

@@ -31,8 +31,6 @@ const createSpanEventAggregator = require('./spans/create-span-event-aggregator'
 const {
   maybeAddDatabaseAttributes,
   maybeAddExternalAttributes,
-  addRequiredCATAttributes,
-  maybeAddExtraCATAttributes,
   maybeAddParentAttributes,
   maybeAddQueueAttributes
 } = require('./util/attributes')
@@ -321,6 +319,18 @@ function Agent(config) {
   this._listenForConfigChanges()
 
   this.initCounters()
+  // Set up data structure to store user defined callbacks for various features
+  this.customCallbacks = {
+    apollo: {
+      // defined with `api.setApolloOperationAttributesCallback`
+      // it is called to add custom attributes to the operation segments
+      operationCallback: null,
+      // defined with `api.setApolloResolverAttributesCallback`
+      // it is called to add custom attributes to the resolver segments
+      resolverCallback: null
+    }
+  }
+  // TODO: move to `this.customCallbacks`
   this.llm = {}
 
   // Finally, add listeners for the agent's own events.
@@ -751,13 +761,6 @@ function _addIntrinsicAttrsFromTransaction(transaction) {
   if (this.config.distributed_tracing.enabled) {
     transaction.addDistributedTraceIntrinsics(intrinsicAttributes)
     maybeAddParentAttributes(transaction, intrinsicAttributes)
-  } else if (
-    this.config.cross_application_tracer.enabled &&
-    !transaction.invalidIncomingExternalTransaction &&
-    (transaction.referringTransactionGuid || transaction.includesOutboundRequests())
-  ) {
-    addRequiredCATAttributes(transaction, intrinsicAttributes, this.config)
-    maybeAddExtraCATAttributes(transaction, intrinsicAttributes, this.config)
   }
 
   return intrinsicAttributes

package/lib/attributes.js

@@ -102,8 +102,7 @@ class Attributes {
   }
 
   /**
-   * Clears instance attributes. Used for enforcing updated LASP
-   * settings on connect.
+   * Clears instance attributes.
    */
   reset() {
     this.attributes = Object.create(null)

package/lib/collector/api.js

@@ -296,10 +296,6 @@ CollectorAPI.prototype._login = function _login(callback) {
   const agent = this._agent
 
   const preconnectData = { high_security: agent.config.high_security }
-  if (agent.config.security_policies_token) {
-    preconnectData.security_policies_token = agent.config.security_policies_token
-  }
-
   const payload = [preconnectData]
 
   this._methods.preconnect.invoke(payload, this._onPreConnect.bind(this, callback))
@@ -312,7 +308,6 @@ CollectorAPI.prototype._login = function _login(callback) {
  * @returns {void}
  */
 CollectorAPI.prototype._onPreConnect = function _onPreConnect(callback, error, response) {
-  const agent = this._agent
   if (error || !SUCCESS.has(response.status)) {
     callback(error, response)
     return
@@ -320,16 +315,7 @@ CollectorAPI.prototype._onPreConnect = function _onPreConnect(callback, error, r
 
   const res = response.payload || Object.create(null)
   this._handlePreConnectResponse(res)
-
-  const policies = res.security_policies || Object.create(null)
-
-  const laspResponse = agent.config.applyLasp(agent, policies)
-  if (laspResponse.shouldShutdownRun()) {
-    callback(null, laspResponse)
-    return
-  }
-
-  this._getFacts(laspResponse.payload, callback)
+  this._getFacts(callback)
 }
 
 /**
@@ -372,15 +358,11 @@ CollectorAPI.prototype._handlePreConnectResponse = function _handlePreConnectRes
   }
 }
 
-CollectorAPI.prototype._getFacts = function _getFacts(lasp, callback) {
+CollectorAPI.prototype._getFacts = function _getFacts(callback) {
   const agent = this._agent
   const self = this
 
   facts(agent, function getEnvDict(environmentDict) {
-    if (lasp) {
-      environmentDict.security_policies = lasp
-    }
-
     // The collector really likes arrays.
     // In fact, it kind of insists on them.
     const environment = [environmentDict]

package/lib/collector/http-agents.js

@@ -5,7 +5,6 @@
 
 'use strict'
 
-const { HttpsProxyAgent } = require('https-proxy-agent')
 const logger = require('../logger').child({ component: 'http-agent' })
 const https = require('https')
 
@@ -64,6 +63,10 @@ exports.proxyAgent = function proxyAgent(config) {
   }
 
   logger.info(`using proxy: ${proxyUrl}`)
+  // lazy-load `https-proxy-agent` as it is ESM
+  // if required at top it would not allow us to instrument
+  // the core `node:http` correctly.
+  const { HttpsProxyAgent } = require('https-proxy-agent')
   agentProxyWithKeepAlive = new HttpsProxyAgent(proxyUrl, proxyOpts)
   return agentProxyWithKeepAlive
 }

package/lib/collector/remote-method.js

@@ -354,7 +354,9 @@ RemoteMethod.prototype._path = function _path({ redactLicenseKey } = {}) {
   const query = {
     marshal_format: 'json',
     protocol_version: this._protocolVersion,
-    license_key: redactLicenseKey ? 'REDACTED' : this._config.license_key,
+    license_key: redactLicenseKey
+      ? this._config.redacted_license_key
+      : this._config.license_key,
     method: this.name
   }
 

package/lib/config/default.js

@@ -43,12 +43,6 @@ defaultConfig.definition = () => {
      * The user's license key. Must be set by per-app configuration file.
      */
     license_key: '',
-    /**
-     *
-     * Enables/Disables security policies.  Paste your security policies
-     * token from the New Relic Admin below.
-     */
-    security_policies_token: '',
     /**
      * Hostname for the New Relic collector proxy.
      *
@@ -1140,7 +1134,7 @@ defaultConfig.definition = () => {
        */
       exclude_newrelic_header: {
         formatter: boolean,
-        default: false
+        default: true
       },
 
       sampler: {
@@ -1175,20 +1169,6 @@ defaultConfig.definition = () => {
       }
     },
 
-    /**
-     * Controls the use of cross-application tracing.
-     *
-     * @property {boolean} [enabled=false]
-     * Enables tracing transactions across multiple applications. Default is `false`.
-     * This feature has been deprecated in favor of Distributed Tracing (DT).
-     * To fully enable this feature, you must also disable DT in your configuration.
-     */
-    cross_application_tracer: {
-      enabled: {
-        formatter: boolean,
-        default: false
-      }
-    },
     /**
      * Controls behavior of message broker tracing.
      *
@@ -1782,6 +1762,48 @@ defaultConfig.definition = () => {
           formatter: int
         }
       }
+    },
+
+    /**
+     * Stanza for customizing behavior for apollo server instrumentation
+     */
+    apollo_server: {
+      /**
+       * Enable capture of timing of fields resolved with the GraphQLScalarType return type. This may be desired when performing time intensive calculations to return a scalar value. This is not recommended for queries that return a large number of pre-calculated scalar fields.
+       * NOTE: query/mutation resolvers will always be captured even if returning a scalar type.
+       */
+      scalars: {
+        formatter: boolean,
+        default: false
+      },
+      /**
+       * Enable capture of timings for an [IntrospectionQuery](https://www.graphql-js.org/api-v16/utilities/#introspectionquery)
+       */
+      introspection_queries: {
+        formatter: boolean,
+        default: false
+      },
+      /**
+       * Enable capture of timings for a [Service Definition query](https://www.apollographql.com/docs/federation/federation-spec/#fetch-service-capabilities) received from an Apollo Federated Gateway Server.
+       */
+      service_definition_queries: {
+        formatter: boolean,
+        default: false
+      },
+      /**
+       * Enable capture of timings for a [Health Check query](https://www.apollographql.com/docs/federation/api/apollo-gateway/#servicehealthcheck) received from an Apollo Federated Gateway Server.
+       */
+      health_check_queries: {
+        formatter: boolean,
+        default: false
+      },
+      /**
+       * Enable capture of metrics for every field and resolver argument seen for an Apollo query. This is intended to be used to check for any unused fields in your graphql schema.
+       */
+      field_metrics: {
+        formatter: boolean,
+        default: false
+      }
     }
   }
 }

package/lib/config/index.js

@@ -6,14 +6,12 @@
 'use strict'
 
 const AttributeFilter = require('./attribute-filter')
-const CollectorResponse = require('../collector/response')
 const copy = require('../util/copy')
 const { config: defaultConfig, definition, setNestedKey } = require('./default')
 const EventEmitter = require('events').EventEmitter
 const featureFlag = require('../feature_flags')
 const flatten = require('../util/flatten')
 const fs = require('../util/unwrapped-core').fs
-const hashes = require('../util/hashes')
 const os = require('os')
 const parseKey = require('../collector/key-parser').parseKey
 const path = require('path')
@@ -35,7 +33,6 @@ const DEFAULT_MAX_PAYLOAD_SIZE_IN_BYTES = 1_000_000
 const BASE_CONFIG_PATH = require.resolve('../../newrelic')
 const HAS_ARBITRARY_KEYS = new Set(['ignore_messages', 'expected_messages', 'labels'])
 
-const LASP_MAP = require('./lasp').LASP_MAP
 const HSM = require('./hsm')
 const REMOVE_BEFORE_SEND = new Set(['attributeFilter'])
 const SSL_WARNING = 'SSL config key can no longer be disabled, not updating.'
@@ -118,9 +115,7 @@ function Config(config) {
   this.account_id = null
   this.application_id = null
   this.web_transactions_apdex = Object.create(null)
-  this.cross_process_id = null
   this.encoding_key = null
-  this.obfuscatedId = null
   this.primary_application_id = null
   this.trusted_account_ids = null
   this.trusted_account_key = null
@@ -185,14 +180,6 @@ function Config(config) {
 
   // 8. apply high security overrides
   if (this.high_security) {
-    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).'
-      )
-    }
     this._applyHighSecurity()
   }
 
@@ -284,22 +271,9 @@ Config.prototype.onConnect = function onConnect(json, recursion) {
     this._fromServer(json, key)
   }
 
-  this._warnDeprecations()
-
   this.emit('change', this)
 }
 
-Config.prototype._getMostSecure = function getMostSecure(key, currentVal, newVal) {
-  const filter = LASP_MAP[key] && LASP_MAP[key].filter
-  if (!this.security_policies_token || !filter) {
-    // If we aren't applying something vetted by security policies we
-    // just return the new value.
-    return newVal
-  }
-  // Return the most secure if we have a filter to apply
-  return filter(currentVal, newVal)
-}
-
 /**
  * Helper that checks if value from server is false
  * then updates the corresponding configuration enabled flag.
@@ -389,12 +363,8 @@ Config.prototype._fromServer = function _fromServer(params, key) {
       break
 
     // always accept these settings
-    case 'cross_process_id':
     case 'encoding_key':
       this._alwaysUpdateIfChanged(params, key)
-      if (this.cross_process_id && this.encoding_key) {
-        this.obfuscatedId = hashes.obfuscateNameUsingKey(this.cross_process_id, this.encoding_key)
-      }
       break
 
     // always accept these settings
@@ -476,12 +446,6 @@ Config.prototype._fromServer = function _fromServer(params, key) {
       break
 
     //
-    // Cross Application Tracer
-    //
-    case 'cross_application_tracer.enabled':
-      this._updateNestedIfChanged(params, this.cross_application_tracer, key, 'enabled')
-      break
-    //
     // Error Collector
     //
     case 'error_collector.enabled':
@@ -1335,16 +1299,6 @@ Config.prototype._serverlessAppName = function _serverlessAppName() {
   }
 }
 
-/**
- * Disables CAT in serverless mode
- */
-Config.prototype._serverlessCAT = function _serverlessCAT() {
-  if (this.cross_application_tracer.enabled) {
-    this.cross_application_tracer.enabled = false
-    logger.info('Cross application tracing is explicitly disabled in serverless_mode.')
-  }
-}
-
 Config.prototype._serverlessInfiniteTracing = function _serverlessInfiniteTracing() {
   if (this.infinite_tracing.trace_observer.host) {
     this.infinite_tracing.trace_observer.host = ''
@@ -1401,7 +1355,6 @@ Config.prototype._preventServerlessDT = function _preventServerlessDT() {
 
 /**
  * Enforces config rules specific to running in serverless_mode:
- *   - disables cross_application_tracer.enabled if set
  *   - defaults logging to disabled
  *   - verifies data specific to running DT is defined either in config file of env vars
  *
@@ -1410,7 +1363,6 @@ Config.prototype._preventServerlessDT = function _preventServerlessDT() {
 Config.prototype._enforceServerless = function _enforceServerless(inputConfig) {
   if (this.serverless_mode.enabled) {
     this._serverlessAppName()
-    this._serverlessCAT()
     this._serverlessInfiniteTracing()
     this._serverlessLogging(inputConfig)
     this._serverlessNativeMetrics(inputConfig)
@@ -1470,6 +1422,8 @@ Config.prototype._canonicalize = function _canonicalize() {
   if (this.license_key) {
     this.license_key = this.license_key.trim()
   }
+
+  this.redacted_license_key = redactLicenseKey(this.license_key)
 }
 
 /**
@@ -1573,135 +1527,6 @@ Config.prototype._applyHighSecurity = function _applyHighSecurity() {
   }
 }
 
-/**
- * Sends a response to collector for LASP application
- *
- * @param {Array} keys keys from a LASP policy
- * @returns {CollectorResponse} creates CollectorResponse with either preserve or shutdown
- */
-function _laspResponse(keys) {
-  if (keys.length) {
-    logger.error('The agent received one or more unexpected security policies and will shut down.')
-    return CollectorResponse.fatal(null)
-  }
-  return CollectorResponse.success(null)
-}
-
-/**
- * Applies the server side LASP policies to a local configuration object
- *
- * @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
- */
-Config.prototype._buildLaspPolicy = function _buildLaspPolicy(agent, policies) {
-  const config = this
-  const keys = Object.keys(policies)
-  const missingRequired = []
-
-  const finalPolicies = keys.reduce(function applyPolicy(obj, name) {
-    const policy = policies[name]
-    const localMapping = LASP_MAP[name]
-
-    if (!localMapping) {
-      if (!policy.required) {
-        // policy is not implemented in agent -- don't send to connect
-        return obj
-      }
-      // policy is required but does not exist in agent -- fail
-      missingRequired.push(name)
-    } else {
-      const splitConfigName = localMapping.path.split('.')
-      let settingBlock = config[splitConfigName[0]]
-      // pull out the configuration subsection that the option lives in
-      for (let i = 1; i < splitConfigName.length - 1; ++i) {
-        settingBlock = settingBlock[splitConfigName[i]]
-      }
-      const valueName = splitConfigName[splitConfigName.length - 1]
-      const localVal = settingBlock[valueName]
-
-      // Indexes into "allowed values" based on "enabled" setting
-      // to retrieve proper mapping.
-      const policyValues = localMapping.allowedValues
-      const policyValue = policyValues[policy.enabled ? 1 : 0]
-
-      // get the most secure setting between local config and the policy
-      const finalValue = (settingBlock[valueName] = config._getMostSecure(
-        name,
-        localVal,
-        policyValue
-      ))
-      policy.enabled = policyValues.indexOf(finalValue) === 1
-      obj[name] = policy
-
-      if (!policy.enabled && localMapping.applyAdditionalSettings) {
-        localMapping.applyAdditionalSettings(config)
-      }
-
-      if (finalValue !== localVal) {
-        // finalValue is more secure than original local val,
-        // so drop corresponding data
-        localMapping.clearData(agent)
-      }
-    }
-
-    return obj
-  }, Object.create(null))
-
-  return { missingRequired, finalPolicies }
-}
-
-/**
- * Checks policies received from preconnect against those expected
- * by the agent, if LASP-enabled. Responds with an error to shut down
- * the agent if necessary.
- *
- * @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.
- */
-Config.prototype.applyLasp = function applyLasp(agent, policies) {
-  const keys = Object.keys(policies)
-
-  if (!this.security_policies_token) {
-    return _laspResponse(keys)
-  }
-
-  const { finalPolicies, missingRequired } = this._buildLaspPolicy(agent, policies)
-
-  const missingLASP = []
-  for (const name of Object.keys(LASP_MAP)) {
-    if (!policies[name]) {
-      // agent is expecting a policy that was not sent from server -- fail
-      missingLASP.push(name)
-    }
-  }
-
-  let fatalMessage = null
-  if (missingLASP.length) {
-    fatalMessage =
-      'The agent did not receive one or more security policies that it ' +
-      'expected and will shut down: ' +
-      missingLASP.join(', ') +
-      '.'
-  } else if (missingRequired.length) {
-    fatalMessage =
-      'The agent received one or more required security policies that it ' +
-      'does not recognize and will shut down: ' +
-      missingRequired.join(', ') +
-      '. Please check if a newer agent version supports these policies ' +
-      'or contact support.'
-  }
-
-  if (fatalMessage) {
-    logger.error(fatalMessage)
-    return CollectorResponse.fatal(null)
-  }
-
-  return CollectorResponse.success(finalPolicies)
-}
-
 Config.prototype.validateFlags = function validateFlags() {
   for (const key of Object.keys(this.feature_flag)) {
     if (featureFlag.released.indexOf(key) > -1) {
@@ -1727,6 +1552,24 @@ function redactValue(value) {
   return result
 }
 
+/**
+ * Redact a license key, preserving its original length.
+ * The first 10 characters remain visible; the rest are replaced with '*'.
+ * Keys of 10 or fewer characters are fully redacted.
+ *
+ * @param {string} key the license key to redact
+ * @returns {string} the redacted key
+ */
+function redactLicenseKey(key) {
+  if (!key) {
+    return ''
+  }
+  if (key.length <= 10) {
+    return '*'.repeat(key.length)
+  }
+  return key.substring(0, 10) + '*'.repeat(key.length - 10)
+}
+
 /**
  * Get a JSONifiable object containing all settings we want to report to the
  * collector and store in the environment_values table.
@@ -1774,19 +1617,6 @@ Config.prototype.getAggregatorConfig = function getAggregatorConfig(method) {
   }
 }
 
-Config.prototype._warnDeprecations = function _warnDeprecations() {
-  // DT overrides CAT so only warn when CAT is actually used.
-  if (this.cross_application_tracer.enabled && !this.distributed_tracing.enabled) {
-    const deprecationWarning = [
-      '[Deprecation Warning]: Cross Application Tracing (CAT) has been deprecated and will be ',
-      'removed in a future major release. CAT has been replaced by Distributed Tracing (DT). ',
-      'Enable DT by setting distributed_tracing: { enabled: true }.'
-    ].join('')
-
-    logger.infoOnce('Deprecation:CAT', deprecationWarning)
-  }
-}
-
 /**
  * Create a configuration, either from a configuration file or the node
  * process's environment.

package/lib/context-manager/async-local-context-manager.js

@@ -35,7 +35,7 @@ class AsyncLocalContextManager {
 
   /**
    * Set a new active context. Not bound to function execution.
-   * The AsyncLocalStorage method is considered experimental
+   * **Note**: Should only be used in tests
    *
    * @param {object} newContext The context to set as active.
    */
@@ -53,14 +53,8 @@ class AsyncLocalContextManager {
    * @param {Array<*>} [args] Optional arguments object or args array to invoke the callback with.
    * @returns {*} Returns the value returned by the callback function.
    */
-  runInContext(context, callback, cbThis, args) {
-    const toInvoke = cbThis ? callback.bind(cbThis) : callback
-
-    if (args) {
-      return this._asyncLocalStorage.run(context, toInvoke, ...args)
-    }
-
-    return this._asyncLocalStorage.run(context, toInvoke)
+  runInContext(context, callback, cbThis, args = []) {
+    return this._asyncLocalStorage.run(context, Reflect.apply, callback, cbThis, args)
   }
 }
 

package/lib/db/statement-matcher.js

@@ -28,7 +28,7 @@ StatementMatcher.prototype.getParsedStatement = function getParsedStatement(sql)
     // If the cleaner can match this collection, pull out the cleaned up names
     // from there. The spec doesn't want the database names in the collection
     // name, but for legacy reasons we keep it.
-    // TODO: Either update the spec (and CATs) to accept database name in the
+    // TODO: Either update the spec to accept database name in the
     // collection name or remove it here.
     const cleanerMatch = CLEANER.exec(collection)
     if (cleanerMatch && cleanerMatch[4]) {

package/lib/errors/index.js

@@ -293,8 +293,6 @@ function _getErrorEventIntrinsicAttrs(transaction, errorClass, message, expected
 
     if (transaction.agent.config.distributed_tracing.enabled) {
       transaction.addDistributedTraceIntrinsics(attributes)
-    } else {
-      attributes['nr.referringTransactionGuid'] = transaction.referringTransactionGuid
     }
 
     attributes['nr.transactionGuid'] = transaction.id