newrelic 14.1.2 → 14.2.0

package/lib/config/default.js

@@ -149,10 +149,10 @@ defaultConfig.definition = () => {
      * agent management in container based environments.
      */
     agent_control: {
-    /**
-     * Indicates that the agent is being managed by Agent Control. Must be set
-     * to true health monitoring.
-     */
+      /**
+       * Indicates that the agent is being managed by Agent Control. Must be set
+       * to true health monitoring.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -162,11 +162,11 @@ defaultConfig.definition = () => {
        * Settings specific to the health monitoring aspect of Agent Control.
        */
       health: {
-      /**
-       * A string file path to a directory that the agent is expected to write
-       * health status files to. Must be set for health monitoring to be
-       * enabled.
-       */
+        /**
+         * A string file path to a directory that the agent is expected to write
+         * health status files to. Must be set for health monitoring to be
+         * enabled.
+         */
         delivery_location: {
           default: 'file:///newrelic/apm/health'
         },
@@ -220,10 +220,10 @@ defaultConfig.definition = () => {
      * the properties of an event or transaction.
      */
     attributes: {
-    /**
-     * If `true`, enables capture of attributes for all destinations.
-     * If there are specific parameters you want ignored, use `attributes.exclude`.
-     */
+      /**
+       * If `true`, enables capture of attributes for all destinations.
+       * If there are specific parameters you want ignored, use `attributes.exclude`.
+       */
       enabled: {
         formatter: boolean,
         default: true
@@ -281,14 +281,14 @@ defaultConfig.definition = () => {
       }
     },
     logging: {
-    /**
-     * Verbosity of the module's logging. This module uses bunyan
-     * (https://github.com/trentm/node-bunyan) for its logging, and as such the
-     * valid logging levels are 'fatal', 'error', 'warn', 'info', 'debug' and
-     * 'trace'. Logging at levels 'info' and higher is very terse. For support
-     * requests, attaching logs captured at 'trace' level are extremely helpful
-     * in chasing down bugs.
-     */
+      /**
+       * Verbosity of the module's logging. This module uses bunyan
+       * (https://github.com/trentm/node-bunyan) for its logging, and as such the
+       * valid logging levels are 'fatal', 'error', 'warn', 'info', 'debug' and
+       * 'trace'. Logging at levels 'info' and higher is very terse. For support
+       * requests, attaching logs captured at 'trace' level are extremely helpful
+       * in chasing down bugs.
+       */
       level: {
         default: 'info',
         env: 'NEW_RELIC_LOG_LEVEL'
@@ -322,11 +322,11 @@ defaultConfig.definition = () => {
       }
     },
     audit_log: {
-    /**
-     * Enables logging of out bound traffic from the Agent to the Collector.
-     * This field is ignored if trace level logging is enabled.
-     * With trace logging, all traffic is logged.
-     */
+      /**
+       * Enables logging of out bound traffic from the Agent to the Collector.
+       * This field is ignored if trace level logging is enabled.
+       * With trace logging, all traffic is logged.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -349,9 +349,9 @@ defaultConfig.definition = () => {
      */
     error_collector: {
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from error collection.
-       */
+        /**
+         * If `true`, the agent captures attributes from error collection.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -451,10 +451,10 @@ defaultConfig.definition = () => {
      *
      */
     strip_exception_messages: {
-    /**
-     * When `true`, the agent will redact the messages of captured
-     * errors.
-     */
+      /**
+       * When `true`, the agent will redact the messages of captured
+       * errors.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -462,9 +462,9 @@ defaultConfig.definition = () => {
     },
     cloud: {
       aws: {
-      /**
-       * The AWS account ID for the AWS account associated with this app.
-       */
+        /**
+         * The AWS account ID for the AWS account associated with this app.
+         */
         account_id: {
           formatter: int,
           default: null
@@ -476,10 +476,10 @@ defaultConfig.definition = () => {
      * utilization based pricing scheme.
      */
     utilization: {
-    /**
-     * This flag dictates whether the agent attempts to reach out to AWS
-     * to get info about the vm the process is running on.
-     */
+      /**
+       * This flag dictates whether the agent attempts to reach out to AWS
+       * to get info about the vm the process is running on.
+       */
       detect_aws: {
         formatter: boolean,
         default: true
@@ -555,13 +555,26 @@ defaultConfig.definition = () => {
       gcp_use_instance_as_host: {
         default: true,
         formatter: boolean
+      },
+
+      gcp_cloud_run: {
+        /**
+         * When enabled, and `gcp_use_instance_as_host` is also enabled, the
+         * GCP Cloud Run revision (`K_REVISION`) will be prepended to the
+         * instance id when setting the hostname of the running application,
+         * resulting in a hostname of `${K_REVISION}-${instance_id}`.
+         */
+        include_revision_in_host: {
+          default: false,
+          formatter: boolean
+        }
       }
     },
     transaction_tracer: {
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from transaction traces.
-       */
+        /**
+         * If `true`, the agent captures attributes from transaction traces.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -668,14 +681,14 @@ defaultConfig.definition = () => {
      * Rules for naming or ignoring transactions.
      */
     rules: {
-    /**
-     * A list of rules of the format {pattern: 'pattern', name: 'name'} for
-     * matching incoming request URLs and naming the associated New Relic
-     * transactions. Both pattern and name are required. Additional attributes
-     * are ignored. Patterns may have capture groups (following JavaScript
-     * conventions), and names will use $1-style replacement strings. See
-     * the documentation for addNamingRule for important caveats.
-     */
+      /**
+       * A list of rules of the format {pattern: 'pattern', name: 'name'} for
+       * matching incoming request URLs and naming the associated New Relic
+       * transactions. Both pattern and name are required. Additional attributes
+       * are ignored. Patterns may have capture groups (following JavaScript
+       * conventions), and names will use $1-style replacement strings. See
+       * the documentation for addNamingRule for important caveats.
+       */
       name: {
         formatter: objectList,
         default: [],
@@ -718,9 +731,9 @@ defaultConfig.definition = () => {
      */
     browser_monitoring: {
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from browser monitoring.
-       */
+        /**
+         * If `true`, the agent captures attributes from browser monitoring.
+         */
         enabled: {
           formatter: boolean,
           default: false
@@ -791,9 +804,9 @@ defaultConfig.definition = () => {
      * options are disabled when high-security mode is enabled.
      */
     api: {
-    /**
-     * Controls for the `API.addCustomAttribute` method.
-     */
+      /**
+       * Controls for the `API.addCustomAttribute` method.
+       */
       custom_attributes_enabled: {
         formatter: boolean,
         default: true,
@@ -826,9 +839,9 @@ defaultConfig.definition = () => {
      */
     transaction_events: {
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from transaction events.
-       */
+        /**
+         * If `true`, the agent captures attributes from transaction events.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -882,10 +895,10 @@ defaultConfig.definition = () => {
      * Read more here: http://newrelic.com/insights
      */
     custom_insights_events: {
-    /**
-     * If this is disabled, the agent does not collect, nor try to send, custom
-     * event data.
-     */
+      /**
+       * If this is disabled, the agent does not collect, nor try to send, custom
+       * event data.
+       */
       enabled: {
         formatter: boolean,
         default: true
@@ -910,9 +923,9 @@ defaultConfig.definition = () => {
      * This is used to configure properties about the user's host name.
      */
     process_host: {
-    /**
-     * Configurable display name for hosts
-     */
+      /**
+       * Configurable display name for hosts
+       */
       display_name: '',
       /**
        * ip address preference when creating hostnames
@@ -958,9 +971,9 @@ defaultConfig.definition = () => {
      * nodes in transaction traces.
      */
     slow_sql: {
-    /**
-     * Enables and disables `slow_sql` recording.
-     */
+      /**
+       * Enables and disables `slow_sql` recording.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -1009,9 +1022,9 @@ defaultConfig.definition = () => {
      * Controls behavior of gRPC server instrumentation.
      */
     grpc: {
-    /**
-     * Enables recording of non-zero gRPC status codes. Default is `true`.
-     */
+      /**
+       * Enables recording of non-zero gRPC status codes. Default is `true`.
+       */
       record_errors: {
         formatter: boolean,
         default: true
@@ -1036,18 +1049,18 @@ defaultConfig.definition = () => {
      * Controls the behavior of span events produced by the agent.
      */
     span_events: {
-    /**
-     * Enables/disables span event generation
-     */
+      /**
+       * Enables/disables span event generation
+       */
       enabled: {
         formatter: boolean,
         default: true
       },
 
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from span events.
-       */
+        /**
+         * If `true`, the agent captures attributes from span events.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -1083,9 +1096,9 @@ defaultConfig.definition = () => {
      */
     transaction_segments: {
       attributes: {
-      /**
-       * If `true`, the agent captures attributes from transaction segments.
-       */
+        /**
+         * If `true`, the agent captures attributes from transaction segments.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -1118,9 +1131,9 @@ defaultConfig.definition = () => {
      * Default is true.
      */
     distributed_tracing: {
-    /**
-     * Enables/disables distributed tracing.
-     */
+      /**
+       * Enables/disables distributed tracing.
+       */
       enabled: {
         formatter: boolean,
         default: true
@@ -1189,9 +1202,9 @@ defaultConfig.definition = () => {
      */
     infinite_tracing: {
       trace_observer: {
-      /**
-       * The URI HOST of the observer.  Setting this enables infinite tracing.
-       */
+        /**
+         * The URI HOST of the observer.  Setting this enables infinite tracing.
+         */
         host: '',
         /**
          * The URI PORT of the observer.
@@ -1209,9 +1222,9 @@ defaultConfig.definition = () => {
         },
       },
       span_events: {
-      /**
-       * The amount of spans to hold onto before dropping them
-       */
+        /**
+         * The amount of spans to hold onto before dropping them
+         */
         queue_size: {
           formatter: int,
           default: 10000
@@ -1261,6 +1274,16 @@ defaultConfig.definition = () => {
       duration: {
         formatter: int,
         default: 0
+      },
+      source_mapping: {
+        /**
+         * When set to `true`, resolves profiler frames to their original
+         * source files/lines using source maps, instead of the compiled output.
+         */
+        enabled: {
+          formatter: boolean,
+          default: false
+        },
       }
     },
 
@@ -1284,10 +1307,10 @@ defaultConfig.definition = () => {
       }
     },
     plugins: {
-    /**
-     * Controls usage of the native metrics module which samples VM and event
-     * loop data.
-     */
+      /**
+       * Controls usage of the native metrics module which samples VM and event
+       * loop data.
+       */
       native_metrics: {
         enabled: {
           formatter: boolean,
@@ -1301,17 +1324,17 @@ defaultConfig.definition = () => {
      * Controls the behavior of Logs in Context within agent
      */
     application_logging: {
-    /**
-     * Toggles the ability for all application logging features to be enabled.
-     */
+      /**
+       * Toggles the ability for all application logging features to be enabled.
+       */
       enabled: {
         formatter: boolean,
         default: true
       },
       forwarding: {
-      /**
-       * Toggles whether the agent gathers log records for sending to New Relic.
-       */
+        /**
+         * Toggles whether the agent gathers log records for sending to New Relic.
+         */
         enabled: {
           formatter: boolean,
           default: true
@@ -1324,9 +1347,9 @@ defaultConfig.definition = () => {
           default: 10000
         },
         labels: {
-        /**
-         * If `true`, the agent attaches labels to log records.
-         */
+          /**
+           * If `true`, the agent attaches labels to log records.
+           */
           enabled: {
             formatter: boolean,
             default: false
@@ -1341,18 +1364,18 @@ defaultConfig.definition = () => {
         }
       },
       metrics: {
-      /**
-       * Toggles whether the agent gathers logging metrics.
-       */
+        /**
+         * Toggles whether the agent gathers logging metrics.
+         */
         enabled: {
           formatter: boolean,
           default: true
         }
       },
       local_decorating: {
-      /**
-       * Toggles whether the agent performs log decoration on standard log output.
-       */
+        /**
+         * Toggles whether the agent performs log decoration on standard log output.
+         */
         enabled: {
           formatter: boolean,
           default: false
@@ -1389,18 +1412,18 @@ defaultConfig.definition = () => {
      * for transaction trace transaction details
      */
     url_obfuscation: {
-    /**
-     * Toggles whether to obfuscate URL parameters
-     */
+      /**
+       * Toggles whether to obfuscate URL parameters
+       */
       enabled: {
         formatter: boolean,
         default: false
       },
 
       regex: {
-      /**
-       * A regular expression to match URL parameters to obfuscate
-       */
+        /**
+         * A regular expression to match URL parameters to obfuscate
+         */
         pattern: {
           formatter: regex,
           default: null
@@ -1426,9 +1449,9 @@ defaultConfig.definition = () => {
      * Security agent configurations
      */
     security: {
-    /**
-     * Toggles the generation of security events by the security agent.
-     */
+      /**
+       * Toggles the generation of security events by the security agent.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -1493,10 +1516,10 @@ defaultConfig.definition = () => {
        * IAST scan controllers to get more control over IAST analysis
        */
       scan_controllers: {
-      /**
-       * The maximum number of analysis probes or requests
-       * that can be sent to the application in one minute.
-       */
+        /**
+         * The maximum number of analysis probes or requests
+         * that can be sent to the application in one minute.
+         */
         iast_scan_request_rate_limit: {
           formatter: int,
           default: 3600
@@ -1514,10 +1537,10 @@ defaultConfig.definition = () => {
        * Schedule start and stop of IAST scan
        */
       scan_schedule: {
-      /**
-       * The delay field specifies the time in minutes
-       * before an IAST scan begins after the application starts
-       */
+        /**
+         * The delay field specifies the time in minutes
+         * before an IAST scan begins after the application starts
+         */
         delay: {
           formatter: int,
           default: 0
@@ -1552,10 +1575,10 @@ defaultConfig.definition = () => {
        * vulnerability categories, and parameters from IAST analysis.
        */
       exclude_from_iast_scan: {
-      /**
-       * Ignore specific APIs from IAST analysis.
-       * The regex pattern should provide a full match for the URL without the endpoint.
-       */
+        /**
+         * Ignore specific APIs from IAST analysis.
+         * The regex pattern should provide a full match for the URL without the endpoint.
+         */
         api: {
           formatter: array,
           default: []
@@ -1658,9 +1681,9 @@ defaultConfig.definition = () => {
      * effect.
      */
     ai_monitoring: {
-    /**
-     * Toggles the generation of AI monitoring events by the agent.
-     */
+      /**
+       * Toggles the generation of AI monitoring events by the agent.
+       */
       enabled: {
         formatter: boolean,
         default: false
@@ -1704,11 +1727,11 @@ defaultConfig.definition = () => {
      * feature set is in development.
      */
     opentelemetry: {
-    /**
-     * Global switch for the whole OpenTelemetry feature. If it is set to
-     * `false`, any other sub-feature, e.g. `traces`, will not be enabled
-     * regardless of that specific sub-feature setting.
-     */
+      /**
+       * Global switch for the whole OpenTelemetry feature. If it is set to
+       * `false`, any other sub-feature, e.g. `traces`, will not be enabled
+       * regardless of that specific sub-feature setting.
+       */
       enabled: { default: false, formatter: boolean },
 
       /**

package/lib/config/index.js

@@ -958,6 +958,27 @@ Config.prototype.getIPAddresses = function getIPAddresses() {
   return addresses
 }
 
+/**
+ * Determines the GCP Cloud Run host name from the instance id. When
+ * `utilization.gcp_cloud_run.include_revision_in_host` is enabled and the
+ * `K_REVISION` env var is present, the revision is prepended to the instance
+ * id, resulting in a host name of `${K_REVISION}-${gcpId}`.
+ *
+ * @param {object} config agent config
+ * @param {string} gcpId GCP metadata ID
+ * @returns {string} host name
+ */
+function getGcpHostname(config, gcpId) {
+  if (config.utilization.gcp_cloud_run?.include_revision_in_host && process.env.K_REVISION) {
+    const hostname = `${process.env.K_REVISION}-${gcpId}`
+    logger.info('Using GCP revision and instance ID for host name: %s', hostname)
+    return hostname
+  }
+
+  logger.info('Using GCP instance ID for host name: %s', gcpId)
+  return gcpId
+}
+
 /**
  * Gets the system's host name. If that fails, it just returns ipv4/6
  * based on the user's process_host.ipv_preference setting.
@@ -991,8 +1012,7 @@ function getHostnameSafe(gcpId = null) {
       _hostname = process.env.DYNO || os.hostname()
       logger.info('Using Heroku dyno name for host name: %s', _hostname)
     } else if (config.utilization.gcp_use_instance_as_host && process.env.K_SERVICE && gcpId) {
-      _hostname = gcpId
-      logger.info('Using GCP instance ID for host name: %s', _hostname)
+      _hostname = getGcpHostname(config, gcpId)
     } else {
       _hostname = os.hostname()
       logger.info('Using OS hostname for host name: %s', _hostname)

package/lib/instrumentations.js

@@ -12,7 +12,6 @@ module.exports = function instrumentations() {
   return {
     '@prisma/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'aws-sdk': { module: './instrumentation/aws-sdk' },
-    mongodb: { type: InstrumentationDescriptor.TYPE_DATASTORE },
     next: { module: './instrumentation/nextjs' },
     restify: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK }
   }

package/lib/profiling/index.js

@@ -12,6 +12,7 @@ class ProfilingManager {
     this.logger = logger
     this.metrics = agent.metrics
     this.config = agent.config.profiling
+    this.tracer = agent.tracer
     this.samplingInterval = samplingInterval
     this.profilers = new Map()
     this.startTime = null
@@ -25,7 +26,7 @@ class ProfilingManager {
 
     if (this.config.include.includes('cpu') && !this.profilers.has('CpuProfiler')) {
       const { CpuProfiler } = require('./profilers')
-      this.profilers.set('CpuProfiler', new CpuProfiler({ logger: this.logger, samplingInterval: this.samplingInterval }))
+      this.profilers.set('CpuProfiler', new CpuProfiler({ logger: this.logger, samplingInterval: this.samplingInterval, tracer: this.tracer }))
     }
   }