AppMap for JetBrains IDEs

Please see ./description.md for a detailed description of the AppMap plugin for JetBrains IDEs.

Deployment

By default, the plugin ZIP file only bundles the JAR file of the AppMap Java agent.

It's possible to customize settings and/or to bundle AppMap binaries into the plugin ZIP afterward to simplify the deployment.

To apply settings centrally at runtime (from a URL, a local file, or the APPMAP_CONFIG_URL environment variable) rather than by modifying the ZIP, see Organization Configuration.

Customizing Deployment

By modifying the plugin ZIP archive, the deployment can be customized.

The current status of the deployment is shown with action Tools > AppMap > Plugin Status Report.

Settings can be customized by adding a site-config.json file at ./intellij-appmap/site-config.json inside the ZIP file.

The file must be a valid JSON file. It allows configuring telemetry, auto-update of AppMap binaries, and the URLs of the CLI release manifests. By default, no custom telemetry is configured and auto-update is enabled.

Default settings:

{
    "appMap.telemetry": null,
    "appMap.autoUpdateTools": true
}

Splunk Telemetry

For telemetry deployment, only splunk is supported as backend. If Splunk is configured, then the user-setting to turn off telemetry is ignored.

{
    "appMap.telemetry": {
        "backend": "splunk",
        "url": "https://splunk.example.com",
        "token": "my-hec-token",
        "ca": "optional-ca-certificate"
    },
    "appMap.autoUpdateTools": true
}

Manifest URLs

The AppMap and Scanner CLI binaries are downloaded according to release manifests. The manifest URLs can be overridden — for example, to download from an internal mirror in an air-gapped environment:

{
    "appMap.manifest.appmapUrl": "https://artifacts.example.com/appmap-manifest.json",
    "appMap.manifest.scannerUrl": "https://artifacts.example.com/scanner-manifest.json"
}

If unset, the defaults are used:

• appMap.manifest.appmapUrl: https://raw.githubusercontent.com/getappmap/appmap-js/release-manifests/appmap-latest.json
• appMap.manifest.scannerUrl: https://raw.githubusercontent.com/getappmap/appmap-js/release-manifests/scanner-latest.json

Bundling AppMap binaries

The following directory inside the plugin ZIP file is searched for AppMap binaries:

• ./intellij-appmap/resources/

A bundled binary must follow this pattern to be found: {type}-{os}-{arch}-v{version}. OS-specific file extensions like .exe must be appended.

If more than one compatible, bundled binary is found, then the binary with the latest version is preferred.

If a downloaded binary has a higher version than the bundled binary, then the downloaded binary is used. If a downloaded binary and the best-matching bundled binary have the same version, then the bundled binary is used.

Possible values:

• type:
  • appmap
  • scanner
• os:
  • win
  • macos
  • linux
• arch:
  • x64
  • arm64
• version: a version in the SemVer format, e.g. 1.2.3.

Examples:

• ./intellij-appmap/resources/appmap-win-x64-v3.9.1.exe
• ./intellij-appmap/resources/appmap-macos-arm64-v3.9.1.exe
• ./intellij-appmap/resources/appmap-linux-arm64-v3.9.1.exe