Apache SkyWalking Node.js Agent documentation

The Node.js Agent reports distributed traces to Apache SkyWalking OAP. Start with Quick start, then use the pages below when you need more detail.

Setup

• Quick start — install the package and report the first trace.
• Configuration — all environment variables and agent.start() options.
• Start and stop the agent — load order, flush(), and destroy().

Features

• Tracing — trace creation, context transfer, ignored requests, and data limits.

Plugins

• Supported libraries — automatic instrumentation and plugin names.
• AWS SDK v2 — DynamoDB, Lambda, SNS, and SQS instrumentation.

Advanced use

• Serverless — AWS Lambda and Azure Functions wrappers.
• Webpack — current bundle support and its limits.
• Troubleshooting — common setup and reporting problems.

Development and contribution

• Build and test — build the agent and run its checks.
• Plugin development — add or change library instrumentation.
• Release — release steps for maintainers and vote checks.

Published versions are listed on the GitHub Releases page.