-
Notifications
You must be signed in to change notification settings - Fork 709
Add Dashboard Access and Profiling Page #2655
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
7e9913e
Add Dashboard Access, Overview and Profiling Page
TomShawn 14a4877
add empty documents to fix dead link
TomShawn 134cffa
Merge branch 'master' into dashboard-access
TomShawn dfc830d
add profiling document
TomShawn 2cee144
Update dashboard-access.md
TomShawn 0a1642b
update category
TomShawn affd53e
update 4 images
TomShawn ae6d6f2
image changes from #3440
TomShawn 442d652
Apply suggestions from code review
TomShawn bf489ce
address comments from lilian
TomShawn 9138da5
Merge branch 'master' into dashboard-access
sre-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: Access TiDB Dashboard | ||
| summary: Learn how to access TiDB Dashboard. | ||
| category: how-to | ||
| --- | ||
|
|
||
| # Access TiDB Dashboard | ||
|
|
||
| To access TiDB Dashboard, visit <http://127.0.0.1:2379/dashboard> via your browser. Replace `127.0.0.1:2379` with the actual PD instance address and port. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If you have deployed multiple PD components in your cluster, you can use the address of only one PD component to access TiDB Dashboard, because the Dashboard operates on only one PD component. If you access via other PD components, your browser is redirected to that PD component. Therefore, if the firewall is not configured for this instance on which PD operates, you might not be able to access TiDB Dashboard. | ||
|
|
||
| ## Browser compatibility | ||
|
|
||
| You can use TiDB Dashboard in the following common desktop browsers of a relatively newer version: | ||
|
|
||
| - Chrome >= 77 | ||
| - Firefox >= 68 | ||
| - Edge >= 17 | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If you use the browsers above of earlier versions or other browsers to access TiDB Dashboard, some functions might not work properly. | ||
|
|
||
| ## Sign in | ||
|
|
||
| For the first-time access, TiDB Dashboard displays the user sign in interface, as shown in the image below. You can sign in using the TiDB `root` account. | ||
|
|
||
|  | ||
|
|
||
| If one of the following situations exists, the login might fail: | ||
|
|
||
| - TiDB `root` user does not exist. | ||
| - PD is not started or cannot be accessed. | ||
| - TiDB is not started or cannot be accessed. | ||
| - Wrong `root` password. | ||
|
|
||
| Once you have signed in, the session remains valid within the next 24 hours. To learn how to sign out, refer to the [Logout](#logout) section. | ||
|
|
||
| ## Switch language | ||
|
|
||
| The following languages are supported in TiDB Dashboard: | ||
|
|
||
| - English | ||
| - Chinese (simplified) | ||
|
|
||
| In the **SQL User Sign In** page, you can click the **Switch Language** drop-down list to switch the interface language. | ||
|
|
||
|  | ||
|
|
||
| ## Logout | ||
|
|
||
| Once you have logged in, click the login user name in the left navigation bar to switch to the user page. Click the **Logout** button on the user page to log out the current user. After logging out, you need to re-enter your username and password. | ||
|
|
||
|  | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Instance Profiling Page | ||
| summary: Learn the instance profiling page of TiDB Dashboard. | ||
| category: how-to | ||
| --- | ||
|
|
||
| # Instance Profiling Page | ||
|
|
||
| The instance profiling page summarizes the internal performance data of each TiDB instance, TiKV instance, and PD instance. With this page, you can view the instance profiling without restarting these instances. | ||
|
|
||
| The summarized performance data can be displayed as a flame graph or a directed acyclic graph, which visually shows the internal operations and proportions performed on the instances during the performance summary period. With this graph, you can quickly learn the main CPU resource consumption of these instances. | ||
|
|
||
| ## Access the page | ||
|
|
||
| You can access the instance profiling page using one of the following methods: | ||
|
|
||
| - After logging into TiDB Dashboard, click **Advanced Debugging** → **Profile Instances** on the left navigation bar. | ||
|
|
||
|  | ||
|
|
||
| - 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. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| You can also click a single instance on the list to directly view its profiling 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. | ||
|
|
||
|  | ||
|
|
||
| For detailed operations on the profiling status page, see [View profiling status](#view-profiling-status). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check the latest Chinese version and update it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updated part contains links of several documents added in pingcap/docs-cn#3440. For convenience, I'll update the change made to
dashboard-access.mdin another PR together with those newly added documents.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it.