This project is a redistribution of the OpenTelemetry Auto-Instrumentation for NodeJS, preconfigured for use with AWS services. Please check out that project too to get a better understanding of the underlying internals. You won't see much code in this repository since we only apply some small configuration changes, and our OpenTelemetry friends takes care of the rest. The exception to this is support for Application Signals.
We provided a NodeJS agent that can be attached to any application using a supported NodeJS version and dynamically injects bytecode to capture telemetry from a number of popular libraries and frameworks. The telemetry data can be exported in a variety of formats. In addition, the agent and exporter can be configured via command line arguments or environment variables. The net result is the ability to gather telemetry data from a NodeJS application without any code changes.
The official AWS Documentation for getting started with ADOT JS Auto-Instrumentation is under construction. Meanwhile, check out the getting started documentation for manual instrumentation.
For the complete list of supported frameworks, please refer to the OpenTelemetry for JavaScript documentation.
Please note that as per policy, we're providing support via GitHub on a best effort basis. However, if you have AWS Enterprise Support you can create a ticket and we will provide direct support within the respective SLAs.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.
This project is licensed under the Apache-2.0 License.
This project ensures compatibility with the following supported NodeJS versions: 14, 16, 18, 20, 22
Amazon CloudWatch Application Signals components are designed to seamlessly work with all library instrumentations offered by OpenTelemetry NodeJS auto-instrumentation. While upstream OpenTelemetry NodeJS instrumentations are in beta, Application Signals components are stable, production ready and have also been tested for popular libraries/frameworks such as ExpressJS, AWS SDK for JavaScript V3, and others. We will prioritize backward compatibility for Application Signals components, striving to ensure that they remain functional even in the face of potential breaking changes introduced by OpenTelemetry upstream libraries. Please raise an issue if you notice Application Signals doesn't work for a particular OpenTelemetry supported library.
Artifacts released will include a .sha256 file for checksum verification starting from v0.4.0
To verify, run the command shasum -a 256 -c <artifact_name>.sha256
It should return the output <artifact_name>: OK if the validation is successful