The AppMap data format includes code structure (packages, modules, classes, and methods), trace events (function calls, web services, RPC calls, SQL, parameters, return values, exceptions, etc), and code metadata (repo URL, commit SHA, etc). It’s more granular than a performance profile, but it’s less granular than a full debug trace. It’s designed to be optimal for understanding the design intent and structure of code and key data flows.
Run this command in your Node.js project folder (where
package.json is located):
npx @appland/appmap@latest install
You will be guided through a series of steps for installing and configuring the agent.
To use AppMaps in your code editor, you’ll also want to install the corresponding AppMap extension:
When you run your program, the agent reads configuration settings from
install command creates a default
appmap.yml file by scanning the project directories.
We recommend that you review the generated
appmap.yml file and confirm your application name
and a list of directories that will be recorded.
# 'name' should generally be the same as the code repo name. name: MyApp packages: - path: src/server/controllers - path: src/server/data - path: src/server/models - path: src/server/routes - path: src/server/lib shallow: true exclude: - src/server/lib/util
Each entry in the
packages list is a YAML object which has the following keys:
name: MyApp packages: - path: src/server/controllers - path: src/server/routes
name: MyApp packages: - path: dist/controllers - path: dist/routes
pathspecified in the same package entry.
true, only the first function call entry into a package will be recorded. Subsequent function calls within the same package are not recorded unless code execution leaves the package and re-enters it. Default:
appmap-agent-js with the
mocha command and its parameters following the
npx appmap-agent-js -- mocha 'test/**/*.ts'
appmap-agent-js will run the tests. When the tests are complete, the AppMaps will be stored
in the default output directory
jestcommand and its parameters following the
--delimiter. For example:
npx appmap-agent-js -- jest 'test/**/*.ts'
appmap-agent-jswill run the tests. When the tests are complete, the AppMaps will be stored in the default output directory
appmap-agent-js supports the AppMap remote recording API.
This functionality is provided by the AppMap agent. It will hook an existing HTTP engine,
serving HTTP requests to toggle recording on and off.
Note Your application must be using Express.js (directly or indirectly) for remote recording to work. Express.js is requried because AppMap injects its control routes into the Express.js middleware stack. Express-based frameworks such as Nest.js will work, as long as they are using Express under the hood.
appmap-agent-jswith the application-starting command and its parameters following the
--delimiter. For example:
npx appmap-agent-js -- node app/main.js --param1 hello --param2=world
appmap-agent-jswill start the app and inject itself in its http stack. It will listen for remote recording requests on all http ports of the application.
appmap-agent-js command and give it an argument for starting your application and an argument for starting process recording.
npx appmap-agent-js --command="put the command to start your app here" --recorder=process
Then interact with your app using its UI or API, and AppMaps will be generated automatically. You will see them appear in the ‘AppMaps’ tab in the left sidebar and on the ‘Explore AppMaps’ page of the instructions.
The most frequently used
appmap-agent-js parameters are:
--recorder=[mocha|jest|remote|process]: process recorder
mochaif the the command contains
jestif the the command contains
processin all other cases
jestrecorders record AppMaps from test cases automatically
remoterecorder has to be started and stopped manually with http requests
processrecorder records entire processes automatically, from start to finish
--command="_start command_": alternate method of specifying the app- or tests-starting command, wrapped in quotes
--log-level=[debug|info|warning|error]: defaults to
--log-file=_file_: defaults to
--output-dir=_directory_: location of recorded AppMap files, default is
--helpprints out help message to stdout
npx appmap-agent-js --log-level=error --recorder=remote -- node built/app.js
APPMAP_CONFIGURATION_PATHPath to the
appmap.ymlconfig file. Default: appmap.yml
APPMAP_REPOSITORY_DIRECTORYPath to the project’s local git folder. Default: .
Recorded AppMap are saved as
.appmap.json files in the project folders (default location:
Follow the documentation for your IDE to open the recorded