newrelic 6.11.0 → 6.13.1

package/CONTRIBUTING.md

@@ -20,9 +20,9 @@ licensing restrictions.
 
 ### Code of Conduct
 
-Before contributing please read the [code of conduct](./CODE_OF_CONDUCT.md)
+Before contributing please read the [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md)
 
-Note that our [code of conduct](./CODE_OF_CONDUCT.md) applies to all platforms
+Note that our [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) applies to all platforms
 and venues related to this project; please follow it in all your interactions
 with the project and its participants.
 
@@ -45,22 +45,25 @@ contributing to this project, you're welcome to request access to the
 \#oss-contributors channel in the newrelicusers.slack.com workspace. To request
 access, see https://newrelicusers-signup.herokuapp.com/.
 
-## The Code
+## PR Guidelines
 
 ### Version Support
 
-When contributing, keep in mind that New Relic customers (that's you!) are
-running many different versions of Node, some of them pretty old. Changes that
-depend on the newest version of Node will probably be rejected, with prejudice
-if they replace something backwards compatible.
+When contributing, keep in mind that New Relic customers (that's you!) are running many different versions of Node, some of them pretty old. Changes that depend on the newest version of Node will probably be rejected, especially if they replace something backwards compatible.
 
-Be aware that the instrumentation needs to work with a wide range of versions
-of the instrumented modules, and that code that looks nonsensical or
-overcomplicated may be that way for compatibility-related reasons. Read all the
-comments and check the related tests before deciding whether existing code is
-incorrect.
+Be aware that the instrumentation needs to work with a wide range of versions of the instrumented modules, and that code that looks nonsensical or overcomplicated may be that way for compatibility-related reasons. Read all the comments and check the related tests before deciding whether existing code is incorrect.
 
-### Testing
+If you’re planning on contributing a new feature or an otherwise complex contribution, we kindly ask you to start a conversation with the maintainer team by opening up an Github issue first.
+
+### General Guidelines
+
+In general, we try to limit adding third-party production dependencies. If one is necessary, please be prepared to make a clear case for the need.
+
+### Coding Style Guidelines/Conventions
+
+We use eslint to enforce certain coding standards. Please see our [.eslintrc](./.eslintrc.js) file for specific rule configuration.
+
+### Testing Guidelines
 
 The agent includes a suite of unit and functional tests which should be used to
 verify your changes don't break existing functionality.
@@ -101,7 +104,7 @@ where they are:
 
 The service token is the all-caps version of the service name listed above.
 
-#### Running the tests
+#### Running Tests
 
 Running the test suite is simple. Just run:
 
@@ -116,7 +119,7 @@ the unit tests can be run with:
 
     npm run unit
 
-#### Writing tests
+#### Writing Tests
 
 For most contributions it is strongly recommended to add additional tests which
 exercise your changes. This helps us efficiently incorporate your changes into

package/LICENSE

@@ -1,4 +1,4 @@
-Apache License
+                                 Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 

package/NEWS.md

@@ -1,11 +1,50 @@
+## 6.13.1 (2020-09-24):
+
+* Fixed named-pipe check for lambda invocations to avoid race-condition.
+
+  Named-pipe existence will now be checked just prior to first write and then cached.
+
+* Updated README with community-plus header.
+
+* Updated README config copy example.
+
+* Added Open Source Policy workflow.
+
+* Removed repository CoC in favor of centralized CoC at org root.
+
+### 6.13.0 (2020-08-25):
+
+* Added ability for the agent to write to a named pipe, instead of stdout, when in serverless mode.
+
+### 6.12.1 (2020-08-20):
+
+* **Security fix:** Resolves an issue where transaction traces will still capture the request URI when the Node.js agent is configured to exclude the 'request.uri' attribute. This can be problematic for certain customers in environments where sensitive information is included in the URI. See security bulletin [NR20-02](https://docs.newrelic.com/docs/security/new-relic-security/security-bulletins/security-bulletin-nr20-02).
+
+  The request URI will now be excluded from transaction traces if the 'request.uri' attribute has been set to be excluded at either the top-level 'attributes.exclude' configuration or at the 'transaction_tracer.attributes.exclude' configuration.
+
+### 6.12.0 (2020-08-11):
+
+* Fixes obfuscation of SQL queries with large data inserts.
+Special thanks to Tomáš Hanáček (@tomashanacek) for tracking down the issue and providing the fix.
+* On failed instrumentation, prevent multiple requires from re-wrapping shims.
+Special thanks to Ryan Copley (@RyanCopley) for the contribution.
+* Upgrade `async` to `v3.2.0`. Special thanks to Yohan Siguret (@Crow-EH) for the contribution
+* Bumped `@newrelic/native-metrics` to `^5.3.0`.
+* Bumped `@newrelic/aws-sdk` to `^2.0.0`.
+* Bumped `node-test-utilities` to `^4.0.0`.
+* Bumped `@newrelic/superagent` to `^3.0.0`.
+* Bumps `@newrelic/koa` to `^4.0.0`.
+* Updated `SECURITY.md` with coordinated disclosure program link.
+* Updated guidelines and templates for contributing to the project.
+
 ### 6.11.0 (2020-07-07):
 
-* Open-sourced agent under Apache 2.0 license
-  * Added CODE_OF_CONDUCT.md file
-  * Streamlined README.md file
-  * Updated CONTRIBUTING.md file
-  * Added additional guidance to bug report template
-  * Added copyright headers to all source files
+* Updated to Apache 2.0 license
+* Added CODE_OF_CONDUCT.md file
+* Streamlined README.md file
+* Updated CONTRIBUTING.md file
+* Added additional guidance to bug report template
+* Added copyright headers to all source files
 * Added Distributed Tracing option to config file used for first time customers
 * Converted some test files to Node-tap
 * Removed "hidden" and unused code injector diagnostic capability

package/README.md

@@ -1,6 +1,6 @@
-[![Community Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Project.png)](https://opensource.newrelic.com/oss-category/#community-project)
+[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
 
-# New Relic's Node.js agent ![Server Smoke Tests](https://github.com/newrelic/node-newrelic/workflows/Server%20Smoke%20Tests/badge.svg) ![Node Agent CI](https://github.com/newrelic/node-newrelic/workflows/Node%20Agent%20CI/badge.svg)
+# New Relic's Node.js agent [![Server Smoke Tests][3]][4] [![Node Agent CI][5]][6]
 
 [![npm status badge][1]][2]
 
@@ -20,11 +20,11 @@ To use New Relic's Node.js agent entails these three steps, which are described
 
 1. To install the agent for performance monitoring, use your favorite npm-based package manager and install the `newrelic` package into your application:
 
-    $ npm install newrelic
+    `$ npm install newrelic`
 
 2. Then, copy the stock configuration file to your program's base folder:
 
-    $ cp node_modules/newrelic/newrelic.js
+    `$ cp ./node_modules/newrelic/newrelic.js ./<your destination>`
 
 3. Now, add your New Relic license key and application/service name to that file:
 
@@ -70,7 +70,7 @@ The `newrelic` module returns an object with the Node agent's API methods attach
     newrelic.addCustomAttribute('some-attribute', 'some-value')
 ```
 
-You can read more about using the API over on the [New Relic dcumentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api) site.
+You can read more about using the API over on the [New Relic documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api) site.
 
 ## Core agent development and tests
 
@@ -125,17 +125,40 @@ Here are some resources for learning more about the agent:
 
 ## Support
 
-New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
+Should you need assistance with New Relic products, you are in good hands with several support channels.
 
-https://discuss.newrelic.com/c/support-products-agents/node-js-agent/
+If the issue has been confirmed as a bug or is a feature request, please file a GitHub issue.
+
+**Support Channels**
+
+* [New Relic Documentation](https://docs.newrelic.com/docs/agents/nodejs-agent/getting-started/introduction-new-relic-nodejs): Comprehensive guidance for using our platform
+* [New Relic Community](https://discuss.newrelic.com/c/support-products-agents/node-js-agent/): The best place to engage in troubleshooting questions
+* [New Relic Developer](https://developer.newrelic.com/): Resources for building a custom observability applications
+* [New Relic University](https://learn.newrelic.com/): A range of online training for New Relic users of every level
+* [New Relic Technical Support](https://support.newrelic.com/) 24/7/365 ticketed support. Read more about our [Technical Support Offerings](https://docs.newrelic.com/docs/licenses/license-information/general-usage-licenses/support-plan).
+
+
+## Privacy
+At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.
+
+We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address and email address.
+
+Please review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy) for more information.
+
+## Roadmap
+
+See our [roadmap](./ROADMAP_Node.md), to learn more about our product vision, understand our plans, and provide us valuable feedback.
 
 ## Contributing
 
-We encourage your contributions to improve the Node.js agent. Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant.
+We encourage your contributions to improve the Node.js agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
+If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company,  please drop us an email at opensource@newrelic.com.
+
+**A note about vulnerabilities**
 
-You only have to sign the CLA one time per project.
+As noted in our [security policy](https://github.com/newrelic/node-newrelic/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
 
-If you have any questions or need to execute our corporate CLA, (required if your contribution is on behalf of a company),  please drop us an email at opensource@newrelic.com.
+If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).
 
 ## License
 
@@ -146,3 +169,7 @@ The Node.js agent also uses source code from third-party libraries. You can find
 
 [1]: https://nodei.co/npm/newrelic.png
 [2]: https://nodei.co/npm/newrelic
+[3]: https://github.com/newrelic/node-newrelic/workflows/Server%20Smoke%20Tests/badge.svg
+[4]: https://github.com/newrelic/node-newrelic/actions?query=workflow%3A%22Server+Smoke+Tests%22
+[5]: https://github.com/newrelic/node-newrelic/workflows/Node%20Agent%20CI/badge.svg
+[6]: https://github.com/newrelic/node-newrelic/actions?query=workflow%3A%22Node+Agent+CI%22

package/ROADMAP_Node.md

@@ -0,0 +1,24 @@
+# Node Agent Roadmap
+
+## Product Vision
+The goal of the Node agent is to provide complete visibility into the health of your service. The agent provides metrics about the runtime health of your service and the process it runs in, and traces that show how specific requests are performing. It also provides information about the environment in which it is running, so you can identify issues with specific hosts, regions, deployments, and other facets. 
+
+New Relic is moving toward OpenTelemetry. OpenTelemetry is a unified standard for service instrumentation. You will soon see an updated version of the agent that uses the OpenTelemetry SDK and [auto-]instrumentation as its foundation. OpenTelemetry will include a broad set of high-quality community-contributed instrumentation and a powerful vendor-neutral API for adding your own instrumentation.
+
+
+## Roadmap
+### Description
+This roadmap project is broken down into the following sections:
+
+- **Now**:
+    - This section contains features that are currently in progress.
+- **Next**:
+    - This section contains work planned within the next three months. These features may still be deprioritized and moved to Future.
+- **Future**:
+    - This section is for ideas for future work that is alined with the product vision and possible opportunities for community contribution. It contains a list of features that anyone can implement. No guarantees can be provided on if or when these features will be completed.
+     
+
+**The roadmap project is found [here](https://github.com/orgs/newrelic/projects/11)**
+
+#### Disclaimers
+> This roadmap is subject to change at any time. Future items should not be considered commitments.

package/SECURITY.md

@@ -1,20 +1,5 @@
-# How to contact us
+# Reporting Security Vulnerabilities
 
-Please send any issue that you feel affects the security of this module to
-**security@newrelic.com**.
+New Relic is committed to the security of our customers and your data. We believe that engaging with security researchers through our coordinated disclosure program is an important means to achieve our security goals.
 
-# Expectations
-
-If we do not respond promptly, we ask that you give us the benefit of the
-doubt, as it is possible the email went to spam or we have been so focused on
-something else we haven't seen it yet. Please send us a quick message,
-*without detail* to one of the following:
-
-* An issue here on GitHub, with an email address we can use to contact you
-  for a more detailed report.
-* Message [@newrelic](https://twitter.com/newrelic) on Twitter.
-* Give our engineering team a heads up on IRC in #newrelic on Freenode.
-
-# History
-
-No security issues have been reported for this project yet.
+If you believe you have found a security vulnerability in one of our products or websites, we welcome and greatly appreciate you reporting it to New Relic's coordinated disclosure program.  Please see our [website for more information on how to report a vulnerability](https://docs.newrelic.com/docs/security/new-relic-security/data-privacy/reporting-security-vulnerabilities).