Skip to content

Commit 291ed5b

Browse files
committed
incorporate feedback
1 parent c5a76e6 commit 291ed5b

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed
22.9 KB
Loading

docs/profiling/flame-graph.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,41 @@ monikerRange: '>= vs-2022'
1313

1414
# Identify hot paths with a flame graph (C#, Visual Basic, C++, F#)
1515

16-
The **Flame Graph** in the CPU Usage and Instrumentation tools help you identify hot paths in your code by visualizing a call tree. Flame graphs are a visualization of categorized data, created to visualize stack traces of profiled software so that the most frequent code paths can be identified quickly and accurately. The graph gives a visual overview of where time is being spent in your application and you can click on specific nodes to dig into them further.
16+
Visual Studio profiling tools for CPU utilization and instrumentation include the **Flame Graph** view. The **Flame Graph** helps you identify *hot paths* in your code by presenting a visualization of the call tree. The *hot path* is the call stack for the functions that are using the most CPU or the most time, and is often a good place to look for potential performance optimizations. The graph gives a visual overview of where time is being spent in your application and you can click on specific nodes to dig into them further.
1717

18-
![Screenshot showing Flame Graph with tooltips displayed.](./media/vs-2022/flame-graph-tooltips.png "Flame Graph with tooltips displayed")
18+
:::image type="content" source="./media/vs-2022/flame-graph-tooltips.png" alt-text="Screenshot showing Flame Graph with tooltips displayed." lightbox="media/vs-2022/flame-graph-tooltips.png":::
1919

2020
For a tutorial that shows how to improve performance using the flame graph, see [Case study: Beginner's guide to optimizing code](../profiling/optimize-code-using-profiling-tools.md). For information on the CPU profiler, see [Analyze performance by using CPU profiling](../profiling/cpu-usage.md).
2121

2222
## Investigate hot paths
2323

24-
1. The Flame Graph view is in the details view of the tool, above the source line highlighting view. After you've stopped your profiling session, you can view the Flame Graph by clicking **Open details**.
24+
The Flame Graph view is in the details view of *.diagession* report.
2525

26-
![Screenshot showing Open details selected.](./media/vs-2022/flame-graph-open-details.png "Open details view selected")
26+
1. [Start a profiling session](../profiling/cpu-usage.md#collect-cpu-utilization-data) with either the CPU Usage or Instrumentation tool.
27+
28+
1. After you've stopped your profiling session and the report loads, select **Open details**.
29+
30+
![Screenshot showing Open Details selected.](./media/vs-2022/flame-graph-open-details.png "Open details view selected")
2731

2832
1. Select **Flame Graph** in the Current View dropdown selection.
2933

3034
![Screenshot showing Flame Graph view selected.](./media/vs-2022/flame-graph-view.png "Flame Graph view selected")
3135

3236
The Flame Graph view appears.
3337

34-
![Screenshot showing Flame Graph overview displayed.](./media/vs-2022/flame-graph-overview.png "Flame Graph overview displayed")
38+
:::image type="content" source="./media/vs-2022/flame-graph-overview.png" alt-text="Screenshot showing Flame Graph overview displayed." lightbox="media/vs-2022/flame-graph-overview.png":::
39+
40+
By default, the data shown in the Flame Graph represents the same data as shown in the **Call tree** view, which represents the data collection period. Specifically, for CPU Usage, it shows the **Total CPU** values. This value is inclusive, so it includes CPU utilization (that is, CPU computation time) used by calls to the function, and any other functions called by the function. In the same way, for Instrumentation, the graph shows the values equivalent to the **Total** column in the call tree view.
41+
42+
However, if you select a node, the selected node becomes the new baseline and uses 100% of the flame graph width. This allows you to better visualize a complex call tree. Choose **Reset Zoom** to return to the default view.
43+
44+
## Flip the Flame Graph
45+
46+
By default, the flame graph in the tool is shown upside down or as an "icicle chart," where the y-axis is counting stack depth downwards from zero at the top.
3547

36-
1. By default, the flame graph in the tool is shown upside down or as an "icicle chart," where the y-axis is counting stack depth downwards from zero at the top. You can view the standard flame chart layout by clicking **Flip Flame Graph**.
48+
You can view a standard flame chart layout by clicking **Flip Flame Graph**.
3749

38-
![Screenshot showing Flip Flame Graph selected.](./media/vs-2022/flame-graph-flip.png "Flip Flame Graph selected")
50+
![Screenshot showing Flip Flame Graph selected.](./media/vs-2022/flame-graph-flip.png "Flip Flame Graph selected")
3951

4052
## Navigate in the flame graph
4153

0 commit comments

Comments
 (0)