README.md

Elastic APM Node.js Agent

This is the official Node.js agent for Elastic APM.

If you have any feedback or questions, please post them on the Discuss forum.

Installation

npm install elastic-apm-node --save

Quick start

1. To run Elastic APM for your own applications, make sure you have the prerequisites in place first. This agent is compatible with APM Server v6.5 and above. For support for previous releases of the APM Server, use version 1.x of the agent. For details see Getting Started with Elastic APM

2. Now follow the documentation links below relevant to your framework or stack to get set up

Documentation

• Table of contents
• Introduction
• Get started with Express
• Get started with hapi
• Get started with Koa
• Get started with Restify
• Get started with Fastify
• Get started with Lambda
• Get started with a custom Node.js stack
• Advanced Setup and Configuration
• API Reference
• Custom Transactions
• Custom Spans
• Metrics
• Performance Tuning
• Source Map Support
• OpenTracing Support
• Supported Technologies
• Upgrading
• Troubleshooting

Contributing

Contributions are welcome, but we recommend that you take a moment and read our contribution guide first.

To see what data is being sent to the APM Server, use the environment variable ELASTIC_APM_PAYLOAD_LOG_FILE (or the config option payloadLogFile) to specify a log file, e.g:

ELASTIC_APM_PAYLOAD_LOG_FILE=/tmp/payload.ndjson

Please see TESTING.md for instructions on how to run the test suite.

License

BSD-2-Clause

Made with ♥️ and ☕️ by Elastic and our community.