AppMap Browser Extension

About

AppMap remote recording is an easy way to record AppMaps and analyze end-user flows for applications with a web-based UI. Remote recording with the AppMap browser extension is composed of three parts:

  • The AppMap agent for your programming language, which runs on the server side and makes the actual recordings of the code
  • A browser extension which is used to start and finish recordings
  • AppMap Cloud which is used for storing and visualization of AppMaps recorded with the browser extension.

Note: An AppMap Cloud account is required for recording AppMaps with the browser extension. If you do not plan on using AppMap Cloud for advanced AppMap management, we recommend that you use the AppMap code editor extensions for recording and saving AppMap files locally.

How it works

This guide assumes that you have the AppMap agent installed and running with your application server code. By following the steps shown here, you will install the browser extension and use it to create, upload and view an AppMap.

1. Install the AppMap browser extension

  1. Install the AppMap browser extension for either Chrome or Firefox

  2. You will now see the AppMap logo displayed in your extensions area.

AppMap Browser Extension

2. Enable AppMap remote recording for your project

Don't enable AppMap remote recording in production. AppMap remote recording will serve recording results to any client request, without authentication. Remote recordings may contain sensitive data like passwords and API keys.

Ruby

Add the AppMap remote recording middleware.

For example, in config/initializers/appmap_remote_recording.rb :

require 'appmap/middleware/remote_recording'

if Rails.env.development?
  Rails.application.config.middleware.insert_after \
    Rails::Rack::Logger,
    AppMap::Middleware::RemoteRecording
end
Start your Rails server.

For example:

$ bundle exec rails server

Java

When you run a Java process with the appmap.jar agent loaded, it will automatically enable remote recording.

Do not load `appmap.jar` in production environments.

3. Record AppMap

Creating a recording is easy.

  1. Click on the AppMap icon next to the search bar in the head of your browser. This will open a small window.
  2. Push the red round button to start recording.
  3. Use your application as you normally would. Go through an end-user flow that you would like to analyze. As you click around and visit pages in your application, the AppMap agent records what is happening on the back end.
  4. When you are finished using your app, open the AppMap browser extension again. Push the red square button to stop recording.
  5. The recorded AppMap will be uploaded to the AppMap Cloud. A new browser tab will open on AppMap Cloud and display the AppMap.

4. View the AppMap

When you stop recording, your AppMap will open in a new browser tab automatically. This may take a minute to render depending on the size of the recording you made. To make it easier to revisit your AppMap, you may want to give it a descriptive name. You can also make the AppMap public, so anyone with the link can view it.

GitHub repository

https://github.com/applandinc/appland-browser-extension


Was this page helpful? thumb_up Yes thumb_down No
Thank you for your feedback!