Rider Profiling Instructions (Java process)

1. Capture CPU usage snapshot
2. Upload snapshot

Capture CPU Snapshot

To provide an informative CPU snapshot you should click on Help | Diagnostic Tools | Start CPU Usage Profiling. You may be prompted to restart the IDE the first time you use this action (to add the necessary VM options). In this case, select Start CPU Usage Profiling again after the restart.

Then perform the actions which are causing performance problems, try to reproduce the performance problem several times while the snapshot is being recorded, then click on the Help | Diagnostic Tools | Stop CPU Usage Profiling to save the snapshot file (snapshot is saved in the user home directory and IDE will show a notification with the exact file name, the extension of the file is .zip). If you don't see a notification and can't find the snapshot file, please check that notifications are enabled for the Profiler.

When reporting the problem, please make sure to describe what you were doing in detail.

1. Capture CPU usage snapshot of slow startup
2. Enabling Profiler Agent
3. Capturing Snapshots
4. Upload snapshot

Enabling Profiler Agent

WINDOWS/MAC/LINUX

Profiler agent is enabled by default in EAP builds, to enable it in the release builds do the following:

1. Help | Edit Custom VM Options
2. At the end of the .vmoptions file add the following line:

Mac:

-agentlib:yjpagent=delay=10000,probe_disable=*

Windows/Linux:

-agentlib:yjpagent64=delay=10000,probe_disable=* 

Linux with 2017.3 or lower product version

-agentlib:yjpagent-linux64=delay=10000,probe_disable=*

Capturing Snapshots

After restarting the IDE you should see two new items under the Tools menu: Start CPU Usage Profiling and Capture Memory Snapshot.

CPU SNAPSHOT

To provide an informative CPU snapshot you should click on Start CPU Usage Profiling and then perform the actions which are causing performance problems, try to reproduce the performance problem several times while the snapshot is being recorded, then click on the Tools | Stop CPU Usage Profiling to save the snapshot file (snapshot is saved in the user home directory and IDE will show a notification with the exact file name, the extension of the file is .zip). If you don't see a notification and can't find the snapshot file, please check that notifications are enabled for the Profiler.

When reporting the problem, please make sure to describe what you were doing in detail.

CPU SNAPSHOT WITH INVOCATION COUNTS

When asked to provide a snapshot with the invocation counts, in addition to the -agentlib... option please also add the following into the .vmoptions file:

-Dprofile.trace=true

Make sure there is no disabletracing option in the -agentlib... line, use the options string from the Enabling Profiling Agent section of this document.

Restart your IDE and capture the CPU snapshot from the Tools menu or using the toolbar button.

MEMORY SNAPSHOT

If the problem you are reporting is related to the heavy memory usage and frequent garbage collection, use the Capture Memory Snapshot menu item. To capture automatic memory snapshots when IDE runs out of memory, add

-XX:+HeapDumpOnOutOfMemoryError

into .vmoptions file. A dump file (.hprof) will be created in the current working directory of the application (<Rider Installation Folder>/bin). In case this directory is read-only, add 

-XX:HeapDumpPath=/dumps/folder

option to change it. See Oracle documentation for more details.

Please note, that memory snapshot may contain the sensitive source code from your project.

1. Capture CPU usage snapshot of slow startup
2. Upload snapshot

Capture CPU usage snapshot of slow startup

Invoke Help | Diagnostic Tools | Profile Slow Startup and Restart the IDE. After the restart, invoke Help | Diagnostic Tools | Stop CPU Usage Profiling.

1. Capture CPU usage snapshot of slow startup
2. Upload snapshot

Capture CPU usage snapshot of slow startup

To profile slow startup by automatically enabling CPU snapshot recording right after IDE is started, please use the sampling option:

-agentlib:yjpagent64=sampling

Adjust this line depending on the OS and the JDK (32-bit/64-bit, see in Help | About). Please check the Enabling Profiler Agent section above. You just need to replace delay=10000 option with the sampling option and make sure NOT to specify the probe_disable=* option.

CPU snapshot file will be saved automatically after your close the IDE into your HOME/snapshots directory with the .snapshot extension.

1. Capture Memory Snapshot
2. Upload snapshot

Memory Snapshot

If the problem you are reporting is related to the heavy memory usage and frequent garbage collection, while increasing the heap size doesn't help, use the Help | Diagnostic Tools | Capture Memory Snapshot (2019.2 and above) or Tools | Capture Memory Snapshot  (2019.1 and earlier) menu item. To capture automatic memory snapshots when IDE runs out of memory, add

-XX:+HeapDumpOnOutOfMemoryError

into .vmoptions file. .hprof dump file will be created in the current working directory of the application (RIDER_HOME/bin). In case this directory is read-only, add

-XX:HeapDumpPath=/dumps/folder

option to change it. See Oracle documentation for more details.

Please, note that memory snapshot may contain the sensitive source code from your project.