newrelic 8.9.0 → 8.11.0

package/NEWS.md

@@ -1,3 +1,65 @@
+### 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.
+
 ### v8.9.0 (2022-03-15)
 
 * Added support for `initializeUnorderedBulkOp`, and `initializeOrderedBulkOp` in mongodb v3 instrumentation.

package/README.md

@@ -145,6 +145,8 @@ Here are some resources for learning more about the agent:
 
 - [The changelog](https://github.com/newrelic/node-newrelic/blob/main/NEWS.md)
 
+- [Example applications](https://github.com/newrelic/newrelic-node-examples) - Working examples of New Relic features in Node.js.
+
 ## Support
 
 Should you need assistance with New Relic products, you are in good hands with several support channels.

package/THIRD_PARTY_NOTICES.md

@@ -19,6 +19,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [@newrelic/aws-sdk](#newrelicaws-sdk)
 * [@newrelic/koa](#newrelickoa)
 * [@newrelic/superagent](#newrelicsuperagent)
+* [@newrelic/winston-enricher](#newrelicwinston-enricher)
 * [@tyriar/fibonacci-heap](#tyriarfibonacci-heap)
 * [async](#async)
 * [concat-stream](#concat-stream)
@@ -712,7 +713,7 @@ This product includes source derived from [@newrelic/aws-sdk](https://github.com
 
 ### @newrelic/koa
 
-This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v6.1.0](https://github.com/newrelic/node-newrelic-koa/tree/v6.1.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v6.1.0/LICENSE):
+This product includes source derived from [@newrelic/koa](https://github.com/newrelic/node-newrelic-koa) ([v6.1.1](https://github.com/newrelic/node-newrelic-koa/tree/v6.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-koa/blob/v6.1.1/LICENSE):
 
 ```
 Apache License
@@ -1128,6 +1129,215 @@ This product includes source derived from [@newrelic/superagent](https://github.
 
 ```
 
+### @newrelic/winston-enricher
+
+This product includes source derived from [@newrelic/winston-enricher](https://github.com/newrelic/newrelic-node-log-extensions) ([v3.1.1](https://github.com/newrelic/newrelic-node-log-extensions/tree/v3.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/newrelic-node-log-extensions/blob/v3.1.1/LICENSE):
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 New Relic, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+```
+
 ### @tyriar/fibonacci-heap
 
 This product includes source derived from [@tyriar/fibonacci-heap](https://github.com/gwtw/ts-fibonacci-heap) ([v2.0.9](https://github.com/gwtw/ts-fibonacci-heap/tree/v2.0.9)), distributed under the [MIT License](https://github.com/gwtw/ts-fibonacci-heap/blob/v2.0.9/LICENSE):
@@ -1770,7 +1980,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.3.0](https://github.com/newrelic/node-test-utilities/tree/v6.3.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.3.0/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.5.2](https://github.com/newrelic/node-test-utilities/tree/v6.5.2)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.5.2/LICENSE):
 
 ```
                                  Apache License
@@ -2456,7 +2666,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### glob
 
-This product includes source derived from [glob](https://github.com/isaacs/node-glob) ([v7.1.7](https://github.com/isaacs/node-glob/tree/v7.1.7)), distributed under the [ISC License](https://github.com/isaacs/node-glob/blob/v7.1.7/LICENSE):
+This product includes source derived from [glob](https://github.com/isaacs/node-glob) ([v7.2.0](https://github.com/isaacs/node-glob/tree/v7.2.0)), distributed under the [ISC License](https://github.com/isaacs/node-glob/blob/v7.2.0/LICENSE):
 
 ```
 The ISC License
@@ -3292,12 +3502,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
@@ -3377,7 +3587,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @newrelic/native-metrics
 
-This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v7.1.1](https://github.com/newrelic/node-native-metrics/tree/v7.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v7.1.1/LICENSE):
+This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v8.0.0](https://github.com/newrelic/node-native-metrics/tree/v8.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v8.0.0/LICENSE):
 
 ```
                                  Apache License

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()
@@ -918,6 +955,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