DataGrip 2021.1 Help

Reporting performance issues

To figure out what is causing a performance issue, you have to collect and submit certain troubleshooting materials to the JetBrains support team. The type of the troubleshooting material depends on the issue that you experience.

You can review the information that is included in the generated HPROF and SNAPSHOT files by using any Java profiler (for example, YourKit ). To review HPROF files, you can also use the profiler of Intellij IDEA Ultimate (Run | Open Profiler Snapshot | Open) .

review HPROF files

The following situations might take place:

  • The IDE does not respond: the application hangs and does not respond to any action for a long time.

  • High CPU usage: the application is working but your performance monitoring utility shows that the application CPU usage is high.

  • High memory consumption or a memory leak: the application is working, but your performance monitoring utility shows that the application memory consumption is high.

  • Slow indexing: the indexing process became slower or cannot be finished.

  • Slow startup: the startup process takes a lot of time.

The IDE does not respond

When DataGrip does not respond, consider creating a thread dump file. A dump file must be created at the moment when the IDE does not respond and include the thread stack. Recording several thread dumps with 1-2 seconds interval might be very useful for the problem analysis.

After you have created a dump thread file, archive it, and upload it to share with the JetBrains support team. Read upload instructions in the Upload snapshots section.

You can create thread dumps by using the following options:

Using jstack

The jstack command-line utility prints Java stack traces of Java threads. The utility is provided with the JDK installation and can be found in the JAVA_HOME\bin directory.

Ensure that the utility has the same JDK version as DataGrip. For example, the 64-bit JDK distribution of the utility will not work for the IDE that runs under the 32-bit JDK distribution. To check the JDK version, press Ctrl+Shift+A, type About, and press Enter.

Check the JDK version

Create thread dumps by using jstack

  1. Open the command prompt.

  2. List Java processes that run on your system with their command-line options. Type the following command and press Enter.

    jps -mv
  3. Run jstack with the IDE process identifier (PID). Type the following command and press Enter.

    jstack -l <PID> > dump.txt

    This command prints the thread dump into a file.

    Using jstack

Automatic thread dumps

DataGrip runs a thread that detects when UI does not respond for a certain time and writes automatic thread dumps into the log directory. To find the log directory, click Help | Show Log in. You will find several folders with the name like threadDumps-freeze-20201215-083634-DB-211.3076. Zip these folders and attach them to your ticket.

Thread dump from the console

Depending on your operating system, you can create a thread dump without the jstack utility.

macOS

  1. Navigate to the datagrip file in IDE_HOME/DataGrip.app/Contents/MacOS/.

    Depending on how you installed your IDE, IDE_HOME might be /Applications/ (standalone installation) or ~/Library/Application Support/JetBrains/Toolbox/apps/datagrip/ch-2/203.5981.102/ (Toolbox installation).

  2. Right-click the datagrip file and select Open with | Terminal.

  3. Press ^\. The terminal will print a thread dump. To complete the process, press ^C.

    thread-dump-on-microsoft-windows

Microsoft Windows

  1. Open the command prompt.

  2. By using the cd command, navigate to the datagrip.bat file in the bin directory inside your IDE installation directory.

    Depending on how you installed your IDE, the installation directory might be C:\Program Files\JetBrains\DataGrip 2020.3\ (standalone installation) or C:\Users\User\AppData\Local\JetBrains\Toolbox\apps\datagrip\ch-1\211.3208\ (Toolbox installation).

  3. Run the datagrip.bat file.

    datagrip.bat > output.txt
  4. Press Ctrl+Break. The terminal will print a thread dump. To complete the process, press Ctrl+C.

Unix

  1. Run the datagrip.sh file in the bin directory inside your IDE installation directory.

    Depending on how you installed your IDE, the installation directory might be any directory that you have chosen (standalone installation) or ~/.local/share/JetBrains/Toolbox/apps/DataGrip/ch-0/211.3208 (Toolbox installation).

  2. By using a process manager (for example, ps, htop, jps ), get the process ID (PID).

  3. Run the following command or send the SIGQUIT signal to the process. A thread dump will be printed in the terminal window.

    db_thread_dump_on_unix

High CPU usage

If you can continue working with the IDE, but the IDE hangs, repeatedly stops responding, displays you warnings about memory consumption, try to close large files (for example, SQL files with thousands of rows), and restart the IDE.

Otherwise, capture the CPU snapshot and IDE logs and send them to the JetBrains support team.

Start CPU usage profiling

  1. Click Help | Diagnostic Tools | Start CPU Usage Profiling.

    DataGrip might ask you to restart IDE to add necessary VM options. If you see this notification, restart the IDE and start the CPU usage profiling again.

  2. Perform the actions that cause performance issues. Try to reproduce the performance problem several times while the snapshot is being recorded.

  3. Click Help | Diagnostic Tools | Stop CPU Usage Profiling.

    DataGrip saves the snapshot file in the user home directory. If you do not see the notification, enable balloon notifications for Profiling in settings. Open settings by pressing Ctrl+Alt+S and navigate to Appearance & Behavior | Notifications. In the list of components, find Profiling and ensure that the Popup type is Balloon.

    Start CPU usage profiling

High memory consumption or a memory leak

The Java Virtual Machine (JVM) running DataGrip allocates some predefined amount of memory. The default value depends on the platform. If you are experiencing slowdowns, you may want to increase the memory heap.

  1. From the main menu, select Help | Change Memory Settings.

  2. Set the necessary amount of memory that you want to allocate and click Save and Restart.

This action changes the value of the -Xmx option used by the JVM and restarts DataGrip with the new setting.

DataGrip also warns you if the amount of free heap memory after a garbage collection is less than 5% of the maximum heap size:

The Low Memory warning

Click Configure to increase the amount of memory allocated by the JVM. If you are not sure what would be a good value, use the one suggested by DataGrip.

The Memory Settings dialog

Click Save and Restart and wait for DataGrip to restart with the new memory heap setting.

If these settings do not fix the problem, capture a memory snapshot, and send it to the JetBrains support team.

Capture a memory snapshot

  • Click Help | Diagnostic Tools | Capture Memory Snapshot.

    Alternatively, press Ctrl+Shift+A, type capture memory, and select Capture Memory Snapshot.

    Wait until the HPROF snapshot is built. You can navigate to it from the notification balloon.

    Capture a memory snapshot

You can capture memory snapshots automatically when the IDE runs out of memory.

Capture memory snapshots automatically

  1. Click Help | Edit Custom VM Options.

  2. In the VMOPTIONS file, add the following lines:

    -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=$USER_HOME/java_error_in_datagrip.hprof

    According to the HeapDumpPath parameter, the HPROF file will be created in the user directory. Alternatively, specify any other directory that has read-write access.

    capture memory snapshots automatically

Slow indexing

Profile the indexing process

  1. Click Help | Diagnostic Tools | Profile Indexing.

  2. Click Invalidate and Restart.

    Wait until DataGrip loads and indexes project files.

  3. Click the Open Snapshot In link to locate the snapshot.

Slow startup

Create a snapshot and share it with the JetBrains support team.

  1. Click Help | Diagnostic Tools | Profile Slow Startup.

  2. In the The Next Startup Will Be Profiled window, click Restart.

  3. In the Startup profiling in progress window, click Show Profile Location.

  4. When you close the IDE, the SNAPSHOT file will appear in the Snapshots directory.

    Slow startup

Upload snapshots

If your snapshot is smaller than 10 MB, you can attach it directly to support tickets or YouTrack issues.

For files larger than 10 MB, use the JetBrains Uploads Service. After the upload is successful, share the Upload ID in the related support case or the Youtrack issue. For more information about getting help, see Getting help.

Consider archiving large or multiple files before uploading. If your upload speed is slow, split large archives into smaller parts.

Last modified: 08 March 2021