From 84dc73723954b963ca17e1d20ced85c65bb353d0 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 5 Jun 2020 00:03:00 +0800 Subject: [PATCH 1/4] add TiDB Dashboard Log Search Page doc --- dashboard/dashboard-log-search.md | 72 +++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 dashboard/dashboard-log-search.md diff --git a/dashboard/dashboard-log-search.md b/dashboard/dashboard-log-search.md new file mode 100644 index 0000000000000..a11b47e1e9f21 --- /dev/null +++ b/dashboard/dashboard-log-search.md @@ -0,0 +1,72 @@ +--- +title: TiDB Dashboard Log Search Page +summary: Learn how to search logs on all nodes using the log search page of TiDB Dashboard. +category: how-to +--- + +# TiDB Dashboard Log Search Page + +On the log search page of TiDB Dashboard, you can search logs on all nodes, preview the search result and download logs. + +## Access the page + +After logging into TiDB Dashboard, you can click **Search Logs** to enter this log search homepage. + +![Log Search Page](/media/dashboard/dashboard-log-search-home.png) + +This page provides the following 4 search parameters: + +- Time range: Specifies the time range of logs to search. The default value is the recent 30 minutes. +- Log level: Specifies the minimum log level. All logs above this log level are searched. The default value is the `INFO`. +- Keywords: The value is optional and can be any legal string. Multiple keywords are separated by spaces. Regular expressions are supported (case-insensitive). +- Components: Selects the cluster components to search, which are multi-select and non-empty. By defaut, all components are selected. + +After clicking the **Search** button, you will enter the detail page of the search results. + +## Page of search result + +The following image shows the page of the search results. + +![Search result](/media/dashboard/dashboard-log-search-result.png) + +This page consists of the following three areas: + +- Parameter options (area 1 in the image above): These options are the same as the parameter options on the search homepage. You can re-select the parameters in the boxes and start a new search. +- Progress (area 2 in the image above): The current search progress is shown on the right side of this page, including the search status and statistics of each node log. +- Search results (area 3 in the image above): + - Time: The time at which the log is generated. The time zone is the same as the time zone of the front-end user. + - Level: log level. + - Component: Shows the component name and its address. + - Log: The body part of each log record, excluding the log time and log level. Logs that are too long are automatically truncated. Click a row to expand the full content. The full log can show up to 512 characters. + +> **Note:** +> +> At most 500 search results can be previewed on this page. You can get the complete search results by downloading them. + +### Search progress + +In the search progress area, a search on a node is called a search task. A search task might have the following statuses: + +- Running: After starting the search, all tasks enter the **Running** status. +- Success: After the task is completed, it automatically enters the **Success** status. At this time, the logs have been cached in the local disk where the Dashboard backend is located, and can be provided to the frontend to download. +- Failed: You have canceled this task, or the task has exited with an error for some reason and enters the **Failed** status. When the task fails, the local temporary files are automatically cleaned. + +The search progress area has the following three control buttons: + +- **Download Selected**: Click this button to download logs of the selected components (only the completed ones can be selected), and you will get a tar file. Unzip this tar file to get one or more zip files (each component corresponds to a zip file). Unzip the zip file(s) to get the log text file. +- **Cancel**: Click this button to cancel all running tasks. You can click this button only when there are running tasks. +- **Retry**: Click this button to retry all failed tasks. You can click this button only when there are failed tasks and no running tasks. + +## Search history list + +Click the **View search history** link on the log search homepage to enter page of search history list: + +![Search history entry](/media/dashboard/dashboard-log-search-history-entry.png) + +![Search history list](/media/dashboard/dashboard-log-search-history.png) + +The history list shows the time range, log level, components, keywords, and search status of each search log. Click the **Detail** link in the **Action** column to jump to the result detail page for this search.： + +You can delete the search history that you no longer need. Click **Delete All** in the upper right corner, or select the rows to be deleted and then click **Delete selected** to delete the history: + +![Delete search history](/media/dashboard/dashboard-log-search-delete-history.png) From 0a4cddf75c9996c7530681f8a0efb9791db1cc3f Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 5 Jun 2020 00:06:25 +0800 Subject: [PATCH 2/4] Update dashboard/dashboard-log-search.md --- dashboard/dashboard-log-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dashboard/dashboard-log-search.md b/dashboard/dashboard-log-search.md index a11b47e1e9f21..ae5e21d2ec3d5 100644 --- a/dashboard/dashboard-log-search.md +++ b/dashboard/dashboard-log-search.md @@ -1,6 +1,6 @@ --- title: TiDB Dashboard Log Search Page -summary: Learn how to search logs on all nodes using the log search page of TiDB Dashboard. +summary: Learn how to search logs of all nodes using the log search page of TiDB Dashboard. category: how-to --- From c5a0dffbd8ddd901b05ab04ccb1537d00a83b50c Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 5 Jun 2020 00:06:33 +0800 Subject: [PATCH 3/4] Update dashboard/dashboard-log-search.md --- dashboard/dashboard-log-search.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dashboard/dashboard-log-search.md b/dashboard/dashboard-log-search.md index ae5e21d2ec3d5..98f53f2725714 100644 --- a/dashboard/dashboard-log-search.md +++ b/dashboard/dashboard-log-search.md @@ -6,7 +6,7 @@ category: how-to # TiDB Dashboard Log Search Page -On the log search page of TiDB Dashboard, you can search logs on all nodes, preview the search result and download logs. +On the log search page of TiDB Dashboard, you can search logs of all nodes, preview the search result and download logs. ## Access the page From 61bda98d668b18be819fd5fbae7fb0b67ede0ce6 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 9 Jun 2020 11:26:57 +0800 Subject: [PATCH 4/4] Address comments from Coco Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> --- dashboard/dashboard-log-search.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/dashboard/dashboard-log-search.md b/dashboard/dashboard-log-search.md index 98f53f2725714..2391f8781c906 100644 --- a/dashboard/dashboard-log-search.md +++ b/dashboard/dashboard-log-search.md @@ -14,14 +14,14 @@ After logging into TiDB Dashboard, you can click **Search Logs** to enter this l ![Log Search Page](/media/dashboard/dashboard-log-search-home.png) -This page provides the following 4 search parameters: +This page provides the following search parameters: - Time range: Specifies the time range of logs to search. The default value is the recent 30 minutes. - Log level: Specifies the minimum log level. All logs above this log level are searched. The default value is the `INFO`. -- Keywords: The value is optional and can be any legal string. Multiple keywords are separated by spaces. Regular expressions are supported (case-insensitive). -- Components: Selects the cluster components to search, which are multi-select and non-empty. By defaut, all components are selected. +- Keywords: The parameter is optional and its value can be any legal string. Multiple keywords are separated by a space. Regular expressions are supported (case-insensitive). +- Components: Selects the cluster components to search, which are multi-select and non-empty. By default, all components are selected. -After clicking the **Search** button, you will enter the detail page of the search results. +After clicking the **Search** button, you enter the detail page of the search results. ## Page of search result @@ -32,7 +32,7 @@ The following image shows the page of the search results. This page consists of the following three areas: - Parameter options (area 1 in the image above): These options are the same as the parameter options on the search homepage. You can re-select the parameters in the boxes and start a new search. -- Progress (area 2 in the image above): The current search progress is shown on the right side of this page, including the search status and statistics of each node log. +- Progress (area 2 in the image above): The current search progress is shown on the right side of this page, including the log search status and statistics of each node. - Search results (area 3 in the image above): - Time: The time at which the log is generated. The time zone is the same as the time zone of the front-end user. - Level: log level. @@ -49,7 +49,7 @@ In the search progress area, a search on a node is called a search task. A searc - Running: After starting the search, all tasks enter the **Running** status. - Success: After the task is completed, it automatically enters the **Success** status. At this time, the logs have been cached in the local disk where the Dashboard backend is located, and can be provided to the frontend to download. -- Failed: You have canceled this task, or the task has exited with an error for some reason and enters the **Failed** status. When the task fails, the local temporary files are automatically cleaned. +- Failed: When you cancel the search task, or the task exits with an error, the task enters the **Failed** status. When the task fails, the local temporary files are automatically cleaned. The search progress area has the following three control buttons: @@ -65,7 +65,7 @@ Click the **View search history** link on the log search homepage to enter page ![Search history list](/media/dashboard/dashboard-log-search-history.png) -The history list shows the time range, log level, components, keywords, and search status of each search log. Click the **Detail** link in the **Action** column to jump to the result detail page for this search.： +The history list shows the time range, log level, components, keywords, and search status of each search log. Click the **Detail** link in the **Action** column to see the search result details: You can delete the search history that you no longer need. Click **Delete All** in the upper right corner, or select the rows to be deleted and then click **Delete selected** to delete the history: