janicduplessis/aws-xray-sdk-node

The official AWS X-Ray SDK for Node.js.

AWS X-Ray SDK for Node.js

Installing

The AWS X-Ray SDK for Node.js is compatible with Node.js version 8 and later. The AWS X-Ray SDK for Node.js has been tested with versions 8.x through 12.x of Node.js. There may be issues when running on versions of Node.js newer than 12.x.

The SDK is available from NPM. For local development, install the SDK in your project directory with npm.

npm install aws-xray-sdk

Use the --save option to save the SDK as a dependency in your application's package.json.

npm install aws-xray-sdk --save

Documentation

This repository hosts all the packages we publish, which each have their own README. The Core package README covers all basic use cases of the main X-Ray SDK. The developer guide provides in-depth guidance about using the AWS X-Ray service. The API Reference provides guidance for using the SDK and module-level documentation.

CHANGELOG.md

Getting Help

Use the following community resources for getting help with the SDK. We use the GitHub issues for tracking bugs and feature requests.

• Ask a question in the AWS X-Ray Forum.
• Open a support ticket with AWS Support.
• If you think you may have found a bug, open an issue.

Opening Issues

If you encounter a bug with the AWS X-Ray SDK for Node.js, we want to hear about it. Before opening a new issue, search the existing issues to see if others are also experiencing the issue. Include the version of the AWS X-Ray SDK for Node.js, Node.js runtime, and other dependencies if applicable. In addition, include the repro case when appropriate.

The GitHub issues are intended for bug reports and feature requests. For help and questions about using the AWS X-Ray SDK for Node.js, use the resources listed in the Getting Help section. Keeping the list of open issues lean helps us respond in a timely manner.

Contributing

We support and accept PRs from the community.

This monorepo hosts the following npm packages for the SDK:

• aws-xray-sdk
• aws-xray-sdk-core
• aws-xray-sdk-express
• aws-xray-sdk-mysql
• aws-xray-sdk-postgres
• aws-xray-sdk-restify

This repo uses Lerna to manage multiple packages. To install Lerna:

npm install lerna

To install devDependencies and peerDependencies for all packages:

lerna bootstrap --hoist

To run tests for all packages:

lerna run test

or go to each package and run npm test as usual.

License

The AWS X-Ray SDK for Node.js is licensed under the Apache 2.0 License. See LICENSE and NOTICE.txt for more information.