xeoncores / apm-agent-nodejs

Elastic APM Node.js Agent

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.

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.2. 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 a custom Node.js stack
• Advanced Setup and Configuration
• API Reference
• Custom Transactions
• Custom Spans
• Source Map Support
• Compatibility Overview
• Upgrading
• Troubleshooting

Contributing

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

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.

Please see the testing section in CONTRIBUTING.md for testing instructions.

License

BSD-2-Clause

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