Troubleshooting

How can I contact someone for support?

A: Chat with us, join us on Discord or send email to [email protected]


Installation

Where should I run the AppMap installer?

A: Run the AppMap installer in the root directory of your project.

  • For a Django or Flask project using Poetry the root directory is the top level folder that contains the poetry.lock file
  • For a Django or Flask project using Pip the root directory is the top level folder that contains the requirements.txt file
  • For a Spring project using Maven the root directory is the top level folder and default location of the pom.xml file
  • For a Spring project using Gradle the root directory is the top level folder that contains the build.gradle file
  • For a Rails project the root directory is the top level folder that contains the Gemfile file

How do I fix a ‘No pip project was able to be located’ error during install?

The installer will look for a requirements.txt file, if that file is not present you may see this error:

No pip project was able to be located at filepath/filename.
requirements.txt was expected to be found at this path, but none could be located.

A: Run the installer in that directory that contains the requirements.txt file.


How do I fix a ‘No poetry project was able to be located’ error during install?

The installer will look for a poetry.lock file, if that file is not present you may see this error:

No poetry project was able to be located at filepath/filename.
poetry.lock was expected to be found at this path, but none could be located.

A: Run the installer in that directory that contains the poetry.lock file.


How do I fix a ‘No Maven project was able to be located’ error during install?

The installer will look for a pom.xml file, if that file is not present you may see this error:

No Maven project was able to be located at filepath/filename.
pom.xml was expected to be found at this path, but none could be located.

A: Run the installer in that directory that contains the pom.xml file..


How do I fix a ‘No Gradle project was able to be located’ error during install?

The installer will look for a gradle.build file, if that file is not present you may see this error:

No Gradle project was able to be located at filepath/filename.
build.gradle was expected to be found at this path, but none could be located.

A: Run the installer in that directory that contains the gradle.build file..


How do I fix a ‘No Bundler project’ error during install?

The installer will look for a Gemfile file, if that file is not present you may see this error:

Error: No Bundler project was able to be located at filepath/filename.
Gemfile was expected to be found at this path, but none could be located.

A: Run the installer in that directory that contains the Gemfile.


General

I see empty AppMaps. Why is it happening and how do I fix them?

A: There are three main reasons why your AppMaps are empty:

  1. The appmap.yml file does not exist or the AppMap agent is not configured to find it at its present location. Make sure the file exists and is picked up by the AppMap agent.
  2. The appmap.yml file is not configured to cover the code of your application. Make sure that it lists all packages/modules, classes and functions that are executed when the AppMaps are recorded.
  3. If you record tests, your tests do not execute code that is configured to be recorded. Review the appmap.yml file (see the answer above), update your tests to execute the code-to-be-recorded or use other methods of AppMap recording if your code coverage is thin.

I do not see AppMaps recorded in the output folders.

A: Make sure that a) appmap.yml exists and is properly configured, b) the AppMap agent is correctly set up, c) the AppMap agent is activated when running tests. Check the language-specific intructions below for additional information.

For a step-by-step AppMap setup guide, visit the Quickstart guide and follow the instructions for your framework and code editor.


Spring applications

No AppMaps are recorded when running tests with Maven.

A: Make sure that a) appmap.yml exists and is properly configured, b) the AppMap plugin is in the correct location in pom.xml, c ) non-standard surefire configuration can prevent the AppMap agent to get activated when running tests. See the Maven plugin guide for details.


No AppMaps are recorded when running tests with Gradle.

A: Make sure that a) appmap.yml exists and is properly configured, b) the AppMap plugin is in the correct location in build.gradle. See the Gradle plugin guide for details.


How do I fix an unknown template for ordinal error?

A: An unknown template for ordinal error happens when PowerMock uses its own ClassLoader to load the com.appland.* classes. To avoid this, you need to instruct PowerMock to ignore these classes. Please see the appmap-java reference documentation for more information.


Rails applications

How do I fix an ‘undefined method’ error when recording AppMaps?

A: Move require 'appmap/rspec' before any other classes get loaded in spec_helper.rb, see Ruby documentation for details.


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