Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 5.85 KB

README.md

File metadata and controls

82 lines (50 loc) · 5.85 KB

New Relic Open Source community plus project banner.

New Relic AWS SDK Instrumentation

npm status badge aws-sdk Instrumentation CI codecov

New Relic's official AWS SDK package instrumentation for use with the Node.js agent. Provides instrumentation for the AWS SDK (aws-sdk) npm package.

Installation

This package is a dependency of the the Node Agent, and the average user should not need to install it manually.

Getting Started

Our instrumentation automatically tracks all SDK calls as "external" activities. In addition, the following have more specific instrumentation to capture additional data store or queue information.

  • Amazon DynamoDB
  • Amazon Simple Notification Service (SNS)
  • Amazon Simple Queue Service (SQS)

Testing

This module includes a list of unit and functional tests. To run these tests, use the following command

$ npm run test

You may also run individual test suites with the following commands

$ npm run unit
$ npm run versioned

Support

Should you need assistance with New Relic products, you are in good hands with several support channels.

If the issue has been confirmed as a bug or is a feature request, please file a GitHub issue.

Support Channels

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 for more information.

Roadmap

See our roadmap, to learn more about our product vision, understand our plans, and provide us valuable feedback.

Contribute

We encourage your contributions to improve New Relic's AWS SDK Instrumentation! 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 [email protected].

A note about vulnerabilities

As noted in our 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 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.

If you would like to contribute to this project, please review these guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to the New Relic AWS SDK Instrumentation package.

License

The New Relic AWS SDK Instrumentation package is licensed under the Apache 2.0 License.