AppLand browser extension

Overview

AppLand "remote recording" is an easy way to record scenarios and analyze end-user flows for applications with a web-based UI. Remote recording is composed of two parts:

  • The AppMap client for your programming language, which runs on the server side and makes the actual recordings of the code. To review setup instructions for the AppMap client, review the client setup instructions.
  • A browser extension which is used to start and finish recordings.
This guide assumes that you have the AppMap client 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 and upload an AppMap, then view the scenario it contains.

Step 1: Install the AppLand browser extension

  1. Install the AppLand browser extension for either Chrome or Firefox
  2. You will now see the AppLand logo displayed in your extensions area.

Step 2: Enable AppLand remote recording for your project

Don't enable AppLand remote recording in production. AppLand 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.

Step 3: Record a scenario

Creating a recording is easy.

  1. Click on the AppLand 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 client records what is happening on the back end.
  4. When you are finished using your app, open the AppLand browser extension again. Push the red square button to stop recording.
  5. The recording will be uploaded to the AppLand website. A new browser tab will open on AppLand and display the recording,

Step 4: View the scenario in AppLand

When you stop recording, your scenario 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 scenario, you may want to give it a descriptive name. You can also make the scenario public, so anyone with the link can view it.