appmap-node

AppMap agent for Node.js.

See the official documentation for full reference.

Usage

Simply use appmap-node in place of node command, or prepend appmap-node to your tool invocation:

$ npx appmap-node foo.js
$ npx appmap-node yarn jest
$ npx appmap-node yarn vitest run
$ npx appmap-node npx ts-node foo.ts

Code Block Recording

You can run appmap-node and use the exposed API to record snippets of interest.

$ npx appmap-node foo.js

foo.js

const{ record }=require("appmap-node");constappmap=record(()=>{hello("world");});// You can consume the details of the appmap objectconsole.log("# of events: ",appmap?.events.length);

Configuration

You can create appmap.yml config file; if not found, a default one will be created:

name: application-name # from package.json by defaultappmap_dir: tmp/appmaplanguage: javascriptpackages:
- path: . # paths to instrument, relative to appmap.yml locationexclude: # code to exclude from instrumentation
- node_modules # these paths are excluded by default
- .yaml # if you create your own config file, you probably want to add them too# You can also exclude methods and functions by name:# - functionName# - Klass.method