newrelic 8.10.0 → 8.11.2

package/NEWS.md

@@ -1,28 +1,73 @@
-### v8.10.0 (2022-04-18)
+### v8.11.2 (2022-05-23)
 
-* Added instrumentation for `mysql2/promise`.
-   * This previously only existed in our standalone `@newrelic/mysql`, but now gives feature partiy between the two.
+* Fixed winston instrumentation to no longer coerce every log line to be json.
 
-* Removed unused native CPU metric sampler.  This logic was no longer getting touched if running Node.js > 6.1.0.
+### v8.11.1 (2022-05-13)
 
-* Fixed promise interceptor from re-throwing errors.
-
-* Added transaction naming documentation ported from a discussion forum post: https://discuss.newrelic.com/t/relic-solution-the-philosophy-of-naming-your-node-agent-transactions/.
-
-* Added `promises.tap.js` to mysql2 versioned tests.
+* Fixed an issue with winston instrumentation that caused agent to crash when creating a winston logger from an existing instantiated logger.
 
+### v8.11.0 (2022-05-11)
+
+* Added application logging for Winston in the Node.js agent
+
+    * Ability to forward logs, send log metrics, and perform local log decoration
+
+    * Added application log aggregator to collect logs with adaptive sampling and appropriate max samples stored.
+
+    * Added `application_logging` configuration and env vars with appropriate defaults.
+
+    * Added `application_logging.enabled` configuration value, defaulting to true.
+
+    * Set `application_logging.forwarding.enabled` to false when High Security Mode (HSM) is set.
+
+    * Enabled log forwarding by default in the example config.
+
+    * Added sent, seen and dropped metrics that collected on every harvest cycle around log lines.
+
+    * Added supportability metrics for some popular logging frameworks.
+    
+    * Added supportability metrics to record if the logging features are enabled.
+
+    * Added a storage mechanisms to transactions to keep logs until transaction ends.
+
+* Removed distributed tracing setting from example config
+
+* Fixed a typo in lib/instrumentation/core/child_process.js
+  Thanks to  Eito Katagiri (@eitoball) for the contribution
+
+* Support automatic instrumentation of Redis v4
+
+* Bumped [moment](https://github.com/moment/moment) from 2.29.1 to 2.29.2.
+
+* Bumped `tap` to 16.x.
+
+* Updated `ansi-regex` to resolve a dev dependency audit warning.
+
+### v8.10.0 (2022-04-18)
+
+* Added instrumentation for `mysql2/promise`.
+   * This previously only existed in our standalone `@newrelic/mysql`, but now gives feature partiy between the two.
+
+* Removed unused native CPU metric sampler.  This logic was no longer getting touched if running Node.js > 6.1.0.
+
+* Fixed promise interceptor from re-throwing errors.
+
+* Added transaction naming documentation ported from a discussion forum post: https://discuss.newrelic.com/t/relic-solution-the-philosophy-of-naming-your-node-agent-transactions/.
+
+* Added `promises.tap.js` to mysql2 versioned tests.
+
 * Updated @newrelic/test-utilities to latest.
- * Removed unused test file in restify versioned tests.
-  * Added `--strict` flag to versioned test runner to properly fail CI runs when test files are not included.
-
-### v8.9.1 (2022-03-22)
-
-* Fixed `shim.wrapReturn` to call `Reflect.construct` in construct Proxy trap.  Also including `newTarget` to work with inherited classes.
-
-* Added link to New Relic Node.js Examples repository.
-
-* Excluded installing dependencies in `versioned-external` folders when running integration tests.
-
+ * Removed unused test file in restify versioned tests.
+  * Added `--strict` flag to versioned test runner to properly fail CI runs when test files are not included.
+
+### v8.9.1 (2022-03-22)
+
+* Fixed `shim.wrapReturn` to call `Reflect.construct` in construct Proxy trap.  Also including `newTarget` to work with inherited classes.
+
+* Added link to New Relic Node.js Examples repository.
+
+* Excluded installing dependencies in `versioned-external` folders when running integration tests.
+
 ### v8.9.0 (2022-03-15)
 
 * Added support for `initializeUnorderedBulkOp`, and `initializeOrderedBulkOp` in mongodb v3 instrumentation.

package/THIRD_PARTY_NOTICES.md

@@ -3292,12 +3292,12 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ### tap
 
-This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v15.1.6](https://github.com/tapjs/node-tap/tree/v15.1.6)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v15.1.6/LICENSE):
+This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.0.1](https://github.com/tapjs/node-tap/tree/v16.0.1)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.0.1/LICENSE):
 
 ```
 The ISC License
 
-Copyright (c) Isaac Z. Schlueter and Contributors
+Copyright (c) 2011-2022 Isaac Z. Schlueter and Contributors
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/api.js

@@ -150,32 +150,7 @@ API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportabilit
     metric.incrementCallCount()
   }
 
-  const agent = this.agent
-
-  const segment = agent.tracer.getSegment()
-  const config = agent.config
-
-  const linkingMetadata = {
-    'entity.name': config.applications()[0],
-    'entity.type': 'SERVICE',
-    'hostname': config.getHostnameSafe()
-  }
-
-  if (config.distributed_tracing.enabled && segment) {
-    linkingMetadata['trace.id'] = segment.transaction.traceId
-    const spanId = segment.getSpanId()
-    if (spanId) {
-      linkingMetadata['span.id'] = spanId
-    }
-  } else {
-    logger.debug('getLinkingMetadata with no active transaction')
-  }
-
-  if (config.entity_guid) {
-    linkingMetadata['entity.guid'] = config.entity_guid
-  }
-
-  return linkingMetadata
+  return this.agent.getLinkingMetadata()
 }
 
 /**

package/lib/agent.js

@@ -16,6 +16,7 @@ const ErrorEventAggregator = require('./errors/error-event-aggregator')
 const EventEmitter = require('events').EventEmitter
 const hashes = require('./util/hashes')
 const logger = require('./logger')
+const LogAggregator = require('./aggregators/log-aggregator')
 const MetricMapper = require('./metrics/mapper')
 const MetricNormalizer = require('./metrics/normalizer')
 const MetricAggregator = require('./metrics/metric-aggregator')
@@ -137,6 +138,16 @@ function Agent(config) {
     this.metrics
   )
 
+  this.logs = new LogAggregator(
+    {
+      periodMs: config.event_harvest_config.report_period_ms,
+      limit: config.event_harvest_config.harvest_limits.log_event_data
+    },
+    this.collector,
+    this.metrics,
+    this
+  )
+
   this.errors = new ErrorCollector(config, errorTraceAggregator, errorEventAggregator, this.metrics)
 
   this._contextManager = createContextManager(this.config)
@@ -366,6 +377,20 @@ Agent.prototype.forceHarvestAll = function forceHarvestAll(callback) {
     promises.push(errorEventPromise)
   }
 
+  if (
+    agent.config.application_logging.enabled &&
+    agent.config.application_logging.forwarding.enabled
+  ) {
+    const logEventPromise = new Promise((resolve) => {
+      agent.logs.once('finished log_event_data data send.', function onLogEventsFinished() {
+        resolve()
+      })
+      agent.logs.send()
+    })
+
+    promises.push(logEventPromise)
+  }
+
   Promise.all(promises).then(() => {
     // Get out of the promise so callback errors aren't treated as
     // promise rejections.
@@ -381,6 +406,7 @@ Agent.prototype.stopAggregators = function stopAggregators() {
   this.spanEventAggregator.stop()
   this.transactionEventAggregator.stop()
   this.customEventAggregator.stop()
+  this.logs.stop()
 }
 
 Agent.prototype.startStreaming = function startStreaming() {
@@ -415,6 +441,13 @@ Agent.prototype.startAggregators = function startAggregators() {
   if (this.config.custom_insights_events.enabled) {
     this.customEventAggregator.start()
   }
+
+  if (
+    this.config.application_logging.enabled &&
+    this.config.application_logging.forwarding.enabled
+  ) {
+    this.logs.start()
+  }
 }
 
 /**
@@ -427,6 +460,8 @@ Agent.prototype.startAggregators = function startAggregators() {
 Agent.prototype.onConnect = function onConnect(shouldImmediatelyHarvest, callback) {
   this._reconfigureAggregators(this.config)
 
+  generateLoggingSupportMetrics(this)
+
   if (this.config.certificates && this.config.certificates.length > 0) {
     this.metrics.getOrCreateMetric(NAMES.FEATURES.CERTIFICATES).incrementCallCount()
   }
@@ -444,6 +479,7 @@ Agent.prototype._reconfigureAggregators = function _reconfigureAggregators(confi
   this.spanEventAggregator.reconfigure(config)
   this.transactionEventAggregator.reconfigure(config)
   this.customEventAggregator.reconfigure(config)
+  this.logs.reconfigure(config)
 }
 
 Agent.prototype._scheduleHarvests = function _scheduleHarvests(shouldImmediatelyHarvest, callback) {
@@ -587,6 +623,7 @@ Agent.prototype.harvestSync = function harvestSync() {
   this.spanEventAggregator.send()
   this.transactionEventAggregator.send()
   this.customEventAggregator.send()
+  this.logs.send()
 
   // Write serverless output
   collector.flushPayloadSync()
@@ -886,6 +923,76 @@ Agent.prototype._listenForConfigChanges = function _listenForConfigChanges() {
   })
 }
 
+/**
+ * This method returns an object with the following keys/data:
+ * - `trace.id`: The current trace ID
+ * - `span.id`: The current span ID
+ * - `entity.name`: The application name specified in the connect request as
+ *   app_name. If multiple application names are specified this will only be
+ *   the first name
+ * - `entity.type`: The string "SERVICE"
+ * - `entity.guid`: The entity ID returned in the connect reply as entity_guid
+ * - `hostname`: The hostname as specified in the connect request as
+ *   utilization.full_hostname. If utilization.full_hostname is null or empty,
+ *   this will be the hostname specified in the connect request as host.
+ *
+ * @returns {LinkingMetadata} The linking object with the data above
+ */
+Agent.prototype.getLinkingMetadata = function getLinkingMetadata() {
+  const segment = this.tracer.getSegment()
+  const config = this.config
+
+  const linkingMetadata = {
+    'entity.name': config.applications()[0],
+    'entity.type': 'SERVICE',
+    'hostname': config.getHostnameSafe()
+  }
+
+  if (config.distributed_tracing.enabled && segment) {
+    linkingMetadata['trace.id'] = segment.transaction.traceId
+    const spanId = segment.getSpanId()
+    if (spanId) {
+      linkingMetadata['span.id'] = spanId
+    }
+  } else {
+    logger.debug('getLinkingMetadata with no active transaction')
+  }
+
+  if (config.entity_guid) {
+    linkingMetadata['entity.guid'] = config.entity_guid
+  }
+
+  return linkingMetadata
+}
+
+/**
+ * Formats the NR-LINKING blob that matches the spec
+ *
+ * @returns {string} formatted NR-LINKING string
+ */
+Agent.prototype.getNRLinkingMetadata = function getNRLinkingMetadata() {
+  const metadata = this.getLinkingMetadata()
+  const nrLinkingMeta = [
+    getValue('entity.guid'),
+    getValue('hostname'),
+    getValue('trace.id'),
+    getValue('span.id'),
+    encodeURIComponent(getValue('entity.name'))
+  ]
+
+  return ` NR-LINKING|${nrLinkingMeta.join('|')}|`
+
+  /**
+   * Retries value for a given key but defaults to `` if falsey
+   *
+   * @param {string} key in linking metadata
+   * @returns {string}
+   */
+  function getValue(key) {
+    return metadata[key] || ''
+  }
+}
+
 function generateEventHarvestSupportMetrics(agent, harvestConfig) {
   const harvestLimits = harvestConfig.harvest_limits
 
@@ -918,6 +1025,31 @@ function generateEventHarvestSupportMetrics(agent, harvestConfig) {
     const spanLimitMetric = agent.metrics.getOrCreateMetric(harvestLimitNames.SPAN)
     spanLimitMetric.recordValue(spanLimit)
   }
+
+  const logLimit = harvestLimits.log_event_data
+  if (logLimit) {
+    const logLimitMetric = agent.metrics.getOrCreateMetric(harvestLimitNames.LOG)
+    logLimitMetric.recordValue(logLimit)
+  }
+}
+
+/**
+ * Increments the call counts of application logging supportability metrics
+ * on every connect cycle
+ *
+ * @param {Agent} agent
+ */
+function generateLoggingSupportMetrics(agent) {
+  const loggingConfig = agent.config.application_logging
+  const logNames = NAMES.LOGGING
+
+  const configKeys = ['metrics', 'forwarding', 'local_decorating']
+  configKeys.forEach((configValue) => {
+    const configFlag =
+      loggingConfig.enabled && loggingConfig[`${configValue}`].enabled ? 'enabled' : 'disabled'
+    const metricName = logNames[`${configValue.toUpperCase()}`]
+    agent.metrics.getOrCreateMetric(`${metricName}${configFlag}`).incrementCallCount()
+  })
 }
 
 module.exports = Agent

package/lib/aggregators/log-aggregator.js

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const logger = require('../logger').child({ component: 'logs_aggregator' })
+const EventAggregator = require('./event-aggregator')
+
+const NAMES = require('../metrics/names')
+
+/**
+ * Aggregates log events up to a certain limit.
+ *
+ * @private
+ * @class
+ */
+class LogAggregator extends EventAggregator {
+  constructor(opts, collector, metrics, agent) {
+    opts = opts || {}
+    opts.method = opts.method || 'log_event_data'
+    opts.metricNames = NAMES.LOGGING
+
+    super(opts, collector, metrics)
+    this.agent = agent
+  }
+
+  _toPayloadSync() {
+    const events = this.events
+
+    if (events.length === 0) {
+      logger.debug('No log events to send.')
+      return
+    }
+
+    const eventData = events.toArray()
+    return [{ logs: eventData }]
+  }
+
+  add(logLine) {
+    const transaction = this.agent.getTransaction()
+    if (transaction) {
+      transaction.logs.add(logLine)
+    } else {
+      super.add(logLine)
+    }
+  }
+
+  addBatch(logs, priority) {
+    logs.forEach((logLine) => {
+      super.add(logLine, priority)
+    })
+  }
+}
+
+module.exports = LogAggregator

package/lib/collector/api.js

@@ -35,6 +35,10 @@ const FAILURE_DISCARD_DATA = new Set([400, 403, 404, 405, 407, 411, 413, 414, 41
 
 const AGENT_RUN_BEHAVIOR = CollectorResponse.AGENT_RUN_BEHAVIOR
 
+/**
+ * @param errors
+ * @param name
+ */
 function dumpErrors(errors, name) {
   let index = 1
 
@@ -49,6 +53,9 @@ function dumpErrors(errors, name) {
   })
 }
 
+/**
+ * @param agent
+ */
 function CollectorAPI(agent) {
   this._agent = agent
   this._reqHeadersMap = null
@@ -73,13 +80,16 @@ function CollectorAPI(agent) {
     customEvents: new RemoteMethod('custom_event_data', agent.config, initialEndpoint),
     queryData: new RemoteMethod('sql_trace_data', agent.config, initialEndpoint),
     errorEvents: new RemoteMethod('error_event_data', agent.config, initialEndpoint),
-    spanEvents: new RemoteMethod('span_event_data', agent.config, initialEndpoint)
+    spanEvents: new RemoteMethod('span_event_data', agent.config, initialEndpoint),
+    logEvents: new RemoteMethod('log_event_data', agent.config, initialEndpoint)
   }
 }
 
 /**
  * Updates all methods except preconnect w/ new host/port pairs sent down from server
  * during preconnect (via redirect_host). Preconnect does not update.
+ *
+ * @param endpoint
  */
 CollectorAPI.prototype._updateEndpoints = function _updateEndpoints(endpoint) {
   logger.trace('Updating endpoints to: ', endpoint)
@@ -121,7 +131,7 @@ CollectorAPI.prototype.connect = function connect(callback) {
    * fix the misconfiguration by setting `proxy` to a fully qualified URL
    *
    * @param {Error} error
-   * @returns {Boolean}
+   * @returns {boolean}
    */
   function isProxyMisconfigured(error) {
     const config = api._agent.config
@@ -134,6 +144,10 @@ CollectorAPI.prototype.connect = function connect(callback) {
     )
   }
 
+  /**
+   * @param error
+   * @param response
+   */
   function retry(error, response) {
     metric.incrementCallCount()
 
@@ -205,6 +219,10 @@ CollectorAPI.prototype._login = function _login(callback) {
 
   methods.preconnect.invoke(payload, onPreConnect)
 
+  /**
+   * @param error
+   * @param response
+   */
   function onPreConnect(error, response) {
     if (error || !SUCCESS.has(response.status)) {
       return callback(error, response)
@@ -276,6 +294,10 @@ CollectorAPI.prototype._connect = function _connect(env, callback) {
 
   methods.connect.invoke(env, onConnect)
 
+  /**
+   * @param error
+   * @param res
+   */
   function onConnect(error, res) {
     if (error || !SUCCESS.has(res.status)) {
       return callback(error, res)
@@ -371,6 +393,10 @@ CollectorAPI.prototype.error_event_data = function errorEvents(events, callback)
 }
 
 CollectorAPI.prototype.analytic_event_data = transactionEvents
+/**
+ * @param events
+ * @param callback
+ */
 function transactionEvents(events, callback) {
   if (!callback) {
     throw new TypeError('callback is required')
@@ -467,6 +493,10 @@ CollectorAPI.prototype.span_event_data = function spanEvents(events, callback) {
  * @param {Function} callback The continuation / error handler.
  */
 CollectorAPI.prototype.transaction_sample_data = transactionSampleData
+/**
+ * @param traces
+ * @param callback
+ */
 function transactionSampleData(traces, callback) {
   if (!callback) {
     throw new TypeError('callback is required')
@@ -478,11 +508,36 @@ function transactionSampleData(traces, callback) {
   this._sendData(this._methods.traces, traces, callback)
 }
 
+/**
+ * Send already-formatted log data by calling log_event_data. For
+ * performance reasons, the API methods do no validation, but the
+ * collector expects data in an exact format. It expects a JSON array
+ * containing the following 2 elements:
+ *
+ * 1. An array of logs.
+ * 2. A list of common attributes(optional).
+ *
+ * @param {Array}    logsRecords   The encoded log entries.
+ * @param logRecords
+ * @param {Function} callback      The continuation / error handler.
+ */
+CollectorAPI.prototype.log_event_data = function errorData(logRecords, callback) {
+  if (!callback) {
+    throw new TypeError('callback is required')
+  }
+  if (!logRecords) {
+    return callback(new TypeError('must pass logRecords to send'))
+  }
+
+  this._sendData(this._methods.logEvents, logRecords, callback)
+}
+
 /**
  * Sends no data aside from the message itself. Clears the run ID, which
  * effectively disconnects the agent from the collector.
  *
  * @param Function callback Runs after the run ID has been cleared.
+ * @param callback
  */
 CollectorAPI.prototype.shutdown = function shutdown(callback) {
   if (!callback) {
@@ -494,6 +549,10 @@ CollectorAPI.prototype.shutdown = function shutdown(callback) {
   const agent = this._agent
   this._methods.shutdown.invoke(null, this._reqHeadersMap, onShutdown)
 
+  /**
+   * @param error
+   * @param response
+   */
   function onShutdown(error, response) {
     if (error) {
       dumpErrors([error], 'shutdown')
@@ -613,6 +672,11 @@ CollectorAPI.prototype.isConnected = function isConnected() {
  * @param {Function} cb             - CollectorAPI method invocation callback
  */
 CollectorAPI.prototype._handleResponseCode = _handleResponseCode
+/**
+ * @param response
+ * @param endpoint
+ * @param cb
+ */
 function _handleResponseCode(response, endpoint, cb) {
   const code = response.status
 
@@ -648,6 +712,11 @@ function _handleResponseCode(response, endpoint, cb) {
   return setImmediate(cb, null, CollectorResponse.discard(null))
 }
 
+/**
+ * @param endpoint
+ * @param code
+ * @param action
+ */
 function logFailure(endpoint, code, action) {
   logger.error('Agent endpoint %s returned %s status. %s.', endpoint, code, action)
 }

package/lib/collector/facts.js

@@ -10,6 +10,12 @@ const fetchSystemInfo = require('../system-info')
 const logger = require('../logger').child({ component: 'facts' })
 const os = require('os')
 const parseLabels = require('../util/label-parser')
+const NAMES = require('../metrics/names')
+
+// For now static and tentative list of which logging libraries we
+// want to track. Later might come up with a better way of populating
+// this list.
+const LOG_LIBRARIES = ['winston', 'bunyan', 'pino', 'loglevel', 'npmlog', 'fancy-log']
 
 module.exports = facts
 
@@ -30,6 +36,8 @@ function facts(agent, callback) {
       const systemInfo = data.systemInfo || Object.create(null)
       const environment = data.environment || []
 
+      countSupportabilityForLogLibraries(environment, agent)
+
       const hostname = agent.config.getHostnameSafe()
       const results = {
         utilization: {
@@ -58,12 +66,22 @@ function facts(agent, callback) {
 
       logger.debug('New Relic metadata %o', results.metadata)
 
+      /**
+       * WARNING: This may not make sense if you are familiar with our config
+       * and updating of config from server.  But the intention here is to always
+       * send the values from user config of harvest limits because on connect these
+       * values get reconfigured based on harvest cycle intervals.  So if you originally
+       * had 1000 and a harvest of 5 seconds the new value of the harvest limit would be 83.
+       * Then every subsequent connect request it would continue to decrease until it eventually hit 0
+       * and we would never be sampling a certain piece of data.
+       */
       results.event_harvest_config = {
         harvest_limits: {
           analytic_event_data: agent.config.transaction_events.max_samples_stored,
           custom_event_data: agent.config.custom_insights_events.max_samples_stored,
           error_event_data: agent.config.error_collector.max_event_samples_stored,
-          span_event_data: agent.config.span_events.max_samples_stored
+          span_event_data: agent.config.span_events.max_samples_stored,
+          log_event_data: agent.config.application_logging.forwarding.max_samples_stored
         }
       }
 
@@ -120,6 +138,8 @@ function getAllIPAddresses() {
  * On the server, the host will still be used as part of the key to determine if two agent
  * connections are the same real agent or a separate one.
  * https://github.com/newrelic/node-newrelic/issues/654
+ *
+ * @param appNames
  */
 function getIdentifierOverride(appNames) {
   const identifier = [
@@ -130,3 +150,23 @@ function getIdentifierOverride(appNames) {
 
   return identifier
 }
+
+/**
+ * This function searches the computed environment for the presence of
+ * some popular logging libraries. If present, it increments the
+ * corresponding supportability metrics.
+ *
+ * @param {Array} environment the environment computed by
+ * @param {object} agent the New Relic agent
+ */
+function countSupportabilityForLogLibraries(environment, agent) {
+  const packages = environment.find((elt) => elt[0] === 'Packages')[1]
+  packages.forEach((pkg) => {
+    pkg = JSON.parse(pkg)[0]
+    if (LOG_LIBRARIES.includes(pkg)) {
+      agent.metrics
+        .getOrCreateMetric(`${NAMES.SUPPORTABILITY.NODEJS_DEPENDENCIES}/${pkg}`)
+        .incrementCallCount()
+    }
+  })
+}