Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 2.65 KB

dashboard-profiling.md

File metadata and controls

53 lines (29 loc) · 2.65 KB
title summary aliases
Manual Profiling
Learn the manual instance profiling of TiDB Dashboard.
/docs/dev/dashboard/dashboard-profiling/

Manual Instance Profiling Page

On the manual instance profiling page, you can collect continuous performance data of TiDB, TiKV, PD, and TiFlash instances without restarting any of them. The data collected can be displayed on a flame graph or a directed acyclic graph. The graph visually shows what internal operations are performed on the instances during the performance summary period and the corresponding proportions. With this graph, you can quickly learn the CPU resource consumption of these instances.

Access the page

You can access the instance profiling page using either of the following methods:

  • After logging into TiDB Dashboard, click Advanced Debugging > Profile Instances > Manually Profile on the left navigation bar.

    Access instance profiling page

  • Visit http://127.0.0.1:2379/dashboard/#/instance_profiling in your browser. Replace 127.0.0.1:2379 with the actual PD instance address and port.

Start Profiling

In the instance profiling page, choose at least one target instance and click Start Profiling to start the instance profiling.

Start instance profiling

You can modify the profiling duration before starting the profiling. This duration is determined by the time needed for the profiling, which is 30 seconds by default. The 30-second duration takes approximately 30 seconds to complete.

View profiling status

After a profiling is started, you can view the profiling status and progress in real time.

Profiling detail

The profiling runs in the background. Refreshing or exiting the current page does not stop the profiling task that is running.

Download profiling result

After the profiling of all instances is completed, you can click Download Profiling Result in the upper right corner to download all profiling results.

Download profiling result

You can also click a single instance on the list to directly view its profiling result.

Single instance result

View profiling history

The profiling history is listed on the instance profiling page. Click one row of the list and you can view the status detail.

View profiling history

For detailed operations on the profiling status page, see View profiling status.