GoLand 2021.3 Help

Read the profiling report

In the Profiler tool window, the collected data is presented on several tabs: Flame Graph, Call Tree, and Method List.

Navigate the report

The Profiler tool window allows you to jump between the tabs while staying focused on a specific method. Right-click the necessary method and select another view in which you want to open it.

Jumping between tabs in the Profiler tool window

For a method on any tab, you can open the Merged Callees and Back Traces trees. Right-click the method and select Method Merged Callees or Method Back Traces respectively.

If you want to review a method in the editor, right-click it on any tab and select Jump to Source or press F4.

Flame Graph

The flame graph visualizes the application call tree with the rectangles that stand for frames of the call stack, ordered by width. Methods that consume more CPU time and memory resources are wider than the others.

Block details shown in the flame graph

When you read the flame graph, focus on the widest blocks. These blocks are the methods that are presented in the profile most. You can start from the bottom and move up, following the code flow from parent to child methods, or use the opposite direction to explore the top blocks that show the functions running directly on the CPU. In this case, you can use the the Presentation Settings button |Show Icicle Graph option change the graph view.

Flame Graph layout

Each block represents a function in the stack (a stack frame). The width of each block corresponds to the method’s CPU time or memory used.

On the Y-axis, there is a stack depth going from bottom up. The X-axis shows the stack profile sorted from the most resource-consuming functions to the least consuming ones.

Show details in tooltips

  • Hover the mouse pointer over a block to display a tooltip.

    The tooltips show the fully qualified method name, the percentage of the parent sample time, and the percentage of total sample time.

Zoom the graph

  • Use the the Zoom in button and the Zoom out button options to zoom the graph.

  • To focus on a specific method, double-click the corresponding block on the graph.

  • To restore the original size of the graph, click 1:1.

  • If you want to locate a specific method on the graph, start typing its name or click Show Search Toolbar and type the name in the search bar.

    The graph highlights all blocks with method names matching your search request.

    Use Previous Occurrence and Next Occurrence for fast navigation between search results. You can also search either in the whole graph or just in a specific subtree.

Using the search in the Flame Graph tab

Capture the graph

You can capture and export the graph separately from other data in the report.

  • Click Capture Image and select Copy to Clipboard or click Save to export the graph as an image in the .png format.

You can visualize the difference between two snapshots on the flame graph.

Compare with a baseline

  1. Open two snapshots. To open snapshots, you can run the profiler twice or go to Run | Open Profiler Snapshot and select snapshots here.

  2. Click the Compare With Baseline button and select the snapshot that you want to compare against.

    A separate diff tab will open with the results of the comparison, combining two flame graphs and showing the differences as red and green.

    If you see that some part of the frame is green, it means that the corresponding method became faster during this profiler run. The red color means that the corresponding method became slower.

    Compare with a baseline

Call Tree

The Call Tree tab represents information about a program’s call stacks that were sampled during profiling.

call tree tab in the profiler results

For each method, the tab shows the following information:

  • Names of methods

  • Percentage of total sample time or parent's sample time

  • The total sample count

  • Recursive calls

Collapse recursive calls

A complex application that has multiple recursive methods may be very difficult to analyze. In a regular Call Tree view, recursive calls are displayed as they are called – one after another, which in case of complex call stacks with multiple recursive calls leads to almost infinite stack scrolling.

GoLand detects a recursion when the same method is called higher up in the call stack. In this case, the subtree is taken out of the call tree and then attached back to the first invocation of that method. This way you can bypass recursion and focus on methods that consume most of the resources and calls that they make.

Collapsing recursive calls allows you to see the total amount of time spent in these calls as if there was no recursion.

Demonstrating collapsed recursive calls

Folded recursive calls are marked with the the Recusrion icon icon on the Call Tree tab. Click it to open the recursive call tree in a separate tab. You can preview the number of merged stacks in a tooltip.

Unfolding a collapsed recursion

What-if: focus on specific methods

GoLand allows you to examine specific methods in the Call Tree: you can exclude particular methods or other way around, focus only on the methods in which you are interested at the moment.

Right-click the necessary method on the Call Tree tab and select one of the following options to open the results in a dedicated tab:

  • Focus On Subtree: show only the selected method call. Parent method sample time counter shows only the time spent in the selected subtree.

  • Focus On Call: show the selected method and the methods that call it. When this option is enabled, every time frame shows only the time spent in the selected method.

  • Exclude Subtree: ignore the selected method call.

  • Exclude Call: ignore all calls to the selected method.

Using the What-if feature

Method List

The Method List collects all methods in the profiled data and sorts them by cumulative sample time. Every item in this list has several views:

  • Back Traces shows the hierarchy of callers. Use this view to trace which methods call the selected method.

  • Merge Callees tries to summarize all methods that are called by the selected one.

  • Callees List shows all methods that were called from the selected one.

method list tab in the profiler results
Last modified: 30 November 2021