Knowledge Base/Troubleshooting

Reporting performance problems

Serge Baranov
posted this on November 25, 2013, 14:08

IDE hangs and doesn't respond

Please refer to this document for reporting the problems when IDE is completely frozen and doesn't respond to any actions for a long time.

If you can continue working with the IDE, but it feels slower than expected, CPU usage is high or there is a memory leak, read below.

Enabling Profiler Agent

Windows/Mac

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

  1. Locate the .vmoptions file for your product (Mac OS users: don't forget to make a copy of the original file to ~/Library/Preferences/<product> and edit this copy instead).
  2. At the end of the .vmoptions file add the following line:
-agentlib:yjpagent=delay=10000

Windows users running under 64-bit JVM and editing <product>64.vmoptions file should use this line instead:

-agentlib:yjpagent64=delay=10000

Linux

Linux users can utilize an alternative way to enable profiler: edit bin/<product>.sh startup script and change IS_EAP="false" to IS_EAP="true".

Agent library name on Linux is different, if you choose to modify the .vmoptions file, use the following: 

-agentlib:yjpagent-linux=delay=10000

or this for the 64-bit systems:

-agentlib:yjpagent-linux64=delay=10000

 

IntelliJ IDEA and PyCharm Community Editions do not include a YourKit profiler agent, because the YourKit agent library is not open-source. To take a CPU or memory snapshot with the Community Edition, you can download an evaluation version of YourKit Java Profiler, copy the yjpagent library to the IDE bin directory, add it to the .vmoptions as described above, and connect to the running IDE instance from the standalone YourKit Profiler UI.

 

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 and save the snapshot file. 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, while increasing the heap size doesn't help, use the Capture Memory Snapshot menu item. To capture automatic memory snapshots when IDE runs out of memory, add -XX:+HeapDumpOnOutOfMemoryError into .vmoptions file. Please note, that memory snapshot may contain the sensitive source code from your project.

Thread Dumps

When IDE hangs and doesn't respond so that you can't use the menu to capture the snapshot, please provide the thread dumps.

 Profiling Slow Startup

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

-agentlib:yjpagent=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.

CPU snapshot file will be saved automatically after your close the IDE into your HOME directory under Snapshots subdirectory and will have .snapshot extension.

Uploading Snapshots to JetBrains FTP Server

After you've saved the snapshot, please upload it to our FTP server: ftp://ftp.intellij.net/.uploads/ (anonymous login, .uploads directory has no permissions to list/download files, only for upload, so that other users will not be able to download your snapshots). Inform JetBrains developers via YouTrack performance problem report about the uploaded file and provide its name (or send this file name to the Support Team via the ticket).

If you can't use FTP, upload the snapshot to some file sharing service, like Dropbox, Google Drive, etc. and send us the link.

 

Comments

User photo
Michael Hirsch

 This line no longer works on 64 bit linux:

      -agentlib:yjpagent64=delay=10000

The line that works is

     -agentlib:yjpagent-linux64=delay=10000

The new line is needed since at least idea-IU-117.798.  The name of the library is now libyjpagent-linux64.so.

February 13, 2014, 21:29
User photo
Serge Baranov
JetBrains

Michael Hirsch, thanks for the correction, I've updated the document.

February 13, 2014, 22:03
User photo
Johnwlockwood

I'm seeing hanging too, with pycharm maxing the CPU for about a minute when it happens, which seems to be when I open a contextual menu.

June 12, 2014, 02:13
User photo
Ryan

I am also seeing hanging in pycharm 3.4 when using the contextual menu. Should I submit some Snapshots?

June 27, 2014, 06:11
User photo
Alex Baumgertner
February 6, 2015, 17:27