AppMap for JetBrains

• AppMap tool window
• “Start with AppMap” for Java
  • Create AppMaps from JUnit test runs
    • Disable specific JUnit tests
  • Running a Java application with AppMap
• Remote recording
• AppMap Plugin actions
• Generate OpenAPI Definitions
• Troubleshooting
• GitHub repository

AppMap tool window

The AppMap tool window shows all AppMaps in your open projects. You can open it from the top level menu (View -> Tools Windows -> AppMaps), with an AppMap action or by clicking on its tab in the UI.

AppMap tool window actions:

• Alphabetical listing of all AppMaps in the project, sorted by name.
• Double-click on any AppMap to open it.
• Search for an AppMap by its name.
• Start/stop remote recordings.
• View the Quickstart guide.

“Start with AppMap” for Java

NOTE: This section only applies to Java applications.

Installing the AppMap JetBrains plugin adds custom buttons and menu options to the JetBrains editor interface. These can be used to run your Java application code with AppMap automatically configured, saving you from manually changing your Maven or Gradle settings. This is the recommended approach for all Java users using JetBrains editors like IntelliJ.

Create AppMaps from JUnit test runs

1. Install the JetBrains plugin if you haven’t already.
2. Open your test file in the editor. Each method marked with JUnit’s @Test annotation will produce an AppMap.
3. Run the test(s) with AppMap by clicking the icon next to the test class and then selecting “Start with AppMap”, or by clicking the AppMap run configuration button:

Disable specific JUnit tests

To disable recording for a particular JUnit test (for example, a performance test), list the class or methods under exclude in the project’s appmap.yml configuration file.

Running a Java application with AppMap

When you run a Java application with the AppMap agent, remote recording will be enabled. (Note: For this to work, your application must include a web server).

1. Install the JetBrains plugin if you haven’t already.
2. Open your application file in the editor.
3. Run your application with AppMap by clicking the icon next to the test class and then selecting “Start with AppMap”, or by clicking the AppMap run configuration button:
4. With the application running, follow the remote recording instructions below to (starting at step 3) create AppMaps.

Remote recording

You can make a remote recording from within the JetBrains IDE.

1. Install the JetBrains plugin if you haven’t already.
2. Start your application with remote recording enabled. For Java, run your Java application with AppMap. For other languages, consult the agent reference for details.
3. To start a recording, click the remote recording button, or use the command Start AppMap recording.
4. Enter the URL where your application is running.
5. Interact with your app through its UI or API. Then click the button to stop the recording, or use the command Stop AppMap recording.
6. You’ll be prompted to save the AppMap to a file, and it will be opened.

For more details about remote recording, see:

• Recording methods > Remote recording
• Remote recording API

AppMap Plugin actions

To open the list of AppMap plugin actions, press CTRL+SHIFT+A on Windows and Linux, or COMMAND+SHIFT+A on macOS, and type AppMap. You can also find these actions at Tools > AppMap of the main menu.

The command names should be self-explanatory.

Generate OpenAPI Definitions

After recording AppMaps for your project, select “Generate OpenAPI” from the AppMap instructions quick start in the lower right hand column.

Selecting the “Generate OpenAPI Definitions” button will open a new file with your OpenAPI definition document to save locally, share with your team or use with 3rd party API management tools like Postman

Troubleshooting

Downloading plugin logs

AppMap technical support may ask you for your IDE logs to diagnose issues with the plugin’s behavior. If so, go to the Help menu in your editor and select Collect Logs and Diagnostic Data. This will create a .zip file on your local machine and open a file explorer window to it. You can then safely send that file to AppMap within your technical support ticket conversation.

GitHub repository

https://github.com/getappmap/appmap-intellij-plugin

---