| 1 |
|
| 2 | ## Requirements
|
| 3 |
|
| 4 | * AWS SDK v2.7.15 or greater (if using `captureAWS` or `captureAWSClient`)
|
| 5 | * Express 4.14.0 or greater (if using Express and the associated X-Ray middleware)
|
| 6 | * MySQL 2.12.0 or greater (if using `captureMySQL`)
|
| 7 | * Postgres 6.1.0 or greater (if using `capturePostgres`)
|
| 8 |
|
| 9 | ## AWS X-Ray
|
| 10 |
|
| 11 | The AWS X-Ray SDK automatically records information for incoming and outgoing requests and responses (via middleware), as well as local data
|
| 12 | such as function calls, time, variables (via metadata and annotations), even EC2 instance data (via plugins).
|
| 13 |
|
| 14 | Although the AWS X-Ray SDK was originally intended to capture request/response data on a web app, the SDK provides functionality for use cases
|
| 15 | outside this as well. The SDK exposes the 'Segment' and 'Subsegment' objects to create your own capturing mechanisms, middleware, etc.
|
| 16 |
|
| 17 | This package includes the following AWS X-Ray packages.
|
| 18 |
|
| 19 | aws-xray-sdk-core
|
| 20 | aws-xray-sdk-express
|
| 21 | aws-xray-sdk-postgres
|
| 22 | aws-xray-sdk-mysql
|
| 23 |
|
| 24 | ## Setup
|
| 25 |
|
| 26 | The core package contains the base SDK functionality. Please see the aws-xray-sdk-core [README.md](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/core/README.md) for more details.
|
| 27 |
|
| 28 | ### Support for web frameworks
|
| 29 |
|
| 30 | * [Express](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/express)
|
| 31 | * [Restify](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/restify)
|