You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by li...@apache.org on 2018/01/14 12:28:39 UTC
[3/4] kylin git commit: APACHE-KYLIN-3155: Create a document for how
to use dashboard
APACHE-KYLIN-3155: Create a document for how to use dashboard
Signed-off-by: lidongsjtu <li...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/3decd849
Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/3decd849
Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/3decd849
Branch: refs/heads/document
Commit: 3decd84956063e900926976556f233d27b5badd1
Parents: 7175ca9
Author: Kalin <qi...@ebay.com>
Authored: Mon Jan 8 04:39:24 2018 +0800
Committer: lidongsjtu <li...@apache.org>
Committed: Sun Jan 14 19:54:34 2018 +0800
----------------------------------------------------------------------
website/_docs21/howto/howto_use_dashboard.md | 102 +++++++++++++++++++
website/images/Dashboard/AVGBuildTimePerMB.jpg | Bin 0 -> 149647 bytes
website/images/Dashboard/AVGQueryLatency.jpg | Bin 0 -> 163229 bytes
website/images/Dashboard/Cube-Info-Page.png | Bin 0 -> 104311 bytes
.../images/Dashboard/Job-Link-Page-Waiting.png | Bin 0 -> 70926 bytes
website/images/Dashboard/Job-Link-Page.png | Bin 0 -> 73430 bytes
website/images/Dashboard/JobCount.jpg | Bin 0 -> 144877 bytes
website/images/Dashboard/Query-Link-Page.png | Bin 0 -> 74150 bytes
website/images/Dashboard/QueryCount.jpg | Bin 0 -> 162002 bytes
website/images/Dashboard/SelectPeriod.png | Bin 0 -> 28878 bytes
10 files changed, 102 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/_docs21/howto/howto_use_dashboard.md
----------------------------------------------------------------------
diff --git a/website/_docs21/howto/howto_use_dashboard.md b/website/_docs21/howto/howto_use_dashboard.md
new file mode 100644
index 0000000..120f4e2
--- /dev/null
+++ b/website/_docs21/howto/howto_use_dashboard.md
@@ -0,0 +1,102 @@
+---
+layout: docs21
+title: Use Dashboard
+categories: howto
+permalink: /docs21/howto/howto_use_dashboard.html
+---
+
+# Dashboard
+
+As a project owner, cube admin, do you want to know your cube usage metrics? Do you want to know how many queries are against your cube every day? What is the AVG query latency? Do you want to know the AVG cube build time per GB source data, which is very helpful to foresee the time cost of a coming cube build job? You can find all information from Kylin Dashboard.
+
+Kylin Dashboard shows useful cube usage statistics, which are very important to our customers.
+
+## How to use it
+
+#### Step 1:
+
+ Click the '**Dashboard**' button on the navigation bar.
+
+ There are 9 boxes on this page which you can operate.
+
+ The boxes represent different attributes, including '**Time Period**','**Total Cube Count**', '**Avg Cube Expansion**', '**Query Count**', '**Average Query Latency**', '**Job Count**', '**Average Build Time per MB**', '**Data grouped by Project**' and '**Data grouped by Time**'.
+
+
+
+#### Step 2:
+
+You should now click on the calender to modify the '**Time Period**'.
+
+
+
+- '**Time period**' is set deafult to **'Last 7 Days**'.
+
+- There are **2** ways to modify the time period, one is *using standard time period*s and the other is *customizing your time period*.
+
+ 1. If you want to *use standard time periods*, you can click on '**Last 7 Days**' to choose data only from last 7 days, or click on '**This Month**' to choose data only from this month, or click on '**Last Month**' to choose data only from last month.
+
+ 2. If you want to *customize your time period*, you can click on '**Custom Range**'.
+
+ There are **2** ways to customize the time period, one is *typing dates in the textfield* and the other is *selecting dates in the calender*.
+
+ 1. If you want to *type dates in the textfield*, please make sure that both dates are valid.
+ 2. If you want to *select dates in the calender*, please make sure that you have clicked on two specific dates.
+
+- After you have modified the time period, click '**Apply**' to apply the changes, click '**Cancel**' to give up the changes.
+
+#### Step 3:
+
+Now the data analysis will be changed and shown on the same page. (Important information has been pixilated.)
+
+- Numbers in '**Total Cube Count**' and '**Avg Cube Expansion**' are in **Blue**.
+
+ You can click the '**More Details**' in these two boxes and you will be led to the '**Model**' page.
+
+ 
+
+
+- Numbers in '**Query Count**', '**Average Query Latency**', '**Job Count**' and '**Average Build Time per MB**' are in **Green**.
+
+ You can click on these four rectangles to get detail infomation about the data you selected. The detail information will then be shown as diagrams and displayed in '**Data grouped by Project**' and '**Data grouped by Time**' boxes.
+
+ 1. '**Query Count**' and '**Average Query Latency**'
+
+ You can click on '**Query Count**' to get detail infomation.
+
+ 
+
+ You can click on '**Average Query Latency**' to get detail infomation.
+
+ 
+
+ You can click the '**More Details**' in these two boxes and you will be led to the '**Insight**' page.
+
+ 
+
+ 2. '**Job Count**' and '**Average Build Time per MB**'
+
+ You can click on '**Job Count**' to get detail infomation.
+
+ 
+
+ You can click on '**Average Build Time per MB**' to get detail information.
+
+ 
+
+ You can click the '**More Details**' in these two boxes and you will be led to the '**Monitor**' page.
+
+ 
+
+ It is common to see the browser showing 'Please wait...'.
+
+ 
+
+#### Step 4:
+
+**Advanced Operations**
+
+'**Data grouped by Project**' and '**Data grouped by Time**' displayed data in the form of diagram.
+
+There is a radio button called '**showValue**' in '**Data grouped by Project**', you can choose to show number in the diagram.
+
+There is a radio drop-down menu in '**Data grouped by Time**', you can choose to show the diagram in different timelines.
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/AVGBuildTimePerMB.jpg
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/AVGBuildTimePerMB.jpg b/website/images/Dashboard/AVGBuildTimePerMB.jpg
new file mode 100644
index 0000000..e9b46a5
Binary files /dev/null and b/website/images/Dashboard/AVGBuildTimePerMB.jpg differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/AVGQueryLatency.jpg
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/AVGQueryLatency.jpg b/website/images/Dashboard/AVGQueryLatency.jpg
new file mode 100644
index 0000000..a84fc86
Binary files /dev/null and b/website/images/Dashboard/AVGQueryLatency.jpg differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/Cube-Info-Page.png
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/Cube-Info-Page.png b/website/images/Dashboard/Cube-Info-Page.png
new file mode 100644
index 0000000..f2b2cd5
Binary files /dev/null and b/website/images/Dashboard/Cube-Info-Page.png differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/Job-Link-Page-Waiting.png
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/Job-Link-Page-Waiting.png b/website/images/Dashboard/Job-Link-Page-Waiting.png
new file mode 100644
index 0000000..95b0512
Binary files /dev/null and b/website/images/Dashboard/Job-Link-Page-Waiting.png differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/Job-Link-Page.png
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/Job-Link-Page.png b/website/images/Dashboard/Job-Link-Page.png
new file mode 100644
index 0000000..4b00459
Binary files /dev/null and b/website/images/Dashboard/Job-Link-Page.png differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/JobCount.jpg
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/JobCount.jpg b/website/images/Dashboard/JobCount.jpg
new file mode 100644
index 0000000..945eff4
Binary files /dev/null and b/website/images/Dashboard/JobCount.jpg differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/Query-Link-Page.png
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/Query-Link-Page.png b/website/images/Dashboard/Query-Link-Page.png
new file mode 100644
index 0000000..eee9493
Binary files /dev/null and b/website/images/Dashboard/Query-Link-Page.png differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/QueryCount.jpg
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/QueryCount.jpg b/website/images/Dashboard/QueryCount.jpg
new file mode 100644
index 0000000..18f8c32
Binary files /dev/null and b/website/images/Dashboard/QueryCount.jpg differ
http://git-wip-us.apache.org/repos/asf/kylin/blob/3decd849/website/images/Dashboard/SelectPeriod.png
----------------------------------------------------------------------
diff --git a/website/images/Dashboard/SelectPeriod.png b/website/images/Dashboard/SelectPeriod.png
new file mode 100755
index 0000000..4fa0940
Binary files /dev/null and b/website/images/Dashboard/SelectPeriod.png differ