This is the official Node.js agent for Elastic APM.
If you are trying out APM and have feedback or questions, please post them on the Discuss forum.
Now follow the documentation links below relevant to your framework or stack to get set up
To ease development,
set the environment variable
DEBUG_PAYLOAD=1 to have the agent dump the JSON payload sent to the APM Server to a temporary file on your local harddrive.
The test suite expects the databases PostgreSQL,
Elasticsearch and Redis to be present.
npm test command will try and start them all automatically before running the tests.
This should work on OS X if the databases are all installed using Homebrew.
To run the linter without running any tests,
npm run lint.
To automatically fix linting errors run
npm run lint-fix.
Running the testsuite on Jenkins is based on docker images.
You can also make use of this setup when running tests locally.
Scripts are provided for different stages of testing: testing the documentation,
running tests against different Node.js versions and running tests against different versions of dependencies.
The scripts are tested with a minimum docker version of
For a full overview of the supported test matrix have a look at Jenkins Configuration.
./test/script/docker/run_tests.sh nodejs-version dependencies
./test/script/docker/run_tests.sh 8 redis,pg
Made with ♥️ and ☕️ by Elastic and our community.