This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch document
in repository https://gitbox.apache.org/repos/asf/kylin.git
commit ca3d15e8d7d71b72d513736fb8501e0c5ba8b8e2
Author: yaqian.zhang <598593...@qq.com>
AuthorDate: Mon Jun 15 18:08:29 2020 +0800
Add doc for system-cube.sh and http metrics api
---
website/_docs31/howto/howto_use_restapi.cn.md | 27 ++++++++++++++++++++++++-
website/_docs31/howto/howto_use_restapi.md | 25 +++++++++++++++++++++++
website/_docs31/tutorial/setup_systemcube.cn.md | 27 +++++++++++++++----------
website/_docs31/tutorial/setup_systemcube.md | 27 +++++++++++++++----------
4 files changed, 83 insertions(+), 23 deletions(-)
diff --git a/website/_docs31/howto/howto_use_restapi.cn.md
b/website/_docs31/howto/howto_use_restapi.cn.md
index 5e402a4..6ad968c 100644
--- a/website/_docs31/howto/howto_use_restapi.cn.md
+++ b/website/_docs31/howto/howto_use_restapi.cn.md
@@ -51,7 +51,10 @@ This page lists the major RESTful APIs provided by Kylin.
* [Get users cannot query the table](#get-users-cannot-query-the-table)
* [Put user to table blacklist](#put-user-to-table-blacklist)
* [Delete user from table blacklist](#delete-user-from-table-blacklist)
-
+* Metrics
+ * [Get all metrics](#get-all-metrics)
+ * [Get specific type of metrics](#get-specific-type-of-metrics)
+
## Authentication
`POST /kylin/api/user/authentication`
@@ -1492,6 +1495,28 @@ This API is specific for stream cube's building;
* table - `required` `string` table name
* name - `required` `string` user name or group name you want to delete from
table blacklist
+***
+
+## Get all metrics
+`GET /kylin/api/jmetrics/`
+
+#### Response sample
+```
+{
+ "version": "3.0.0",
+ "gauges": {},
+ "counters": {},
+ "histograms": {},
+ "meters": {},
+ "timers": {}
+}
+```
+
+## Get specific type of metrics
+`GET /kylin/api/jmetrics/{type}`
+
+#### Path variable
+* type - `required` `string` Specific type of metrics you want, e.g meters
## Use RESTful API in Javascript
diff --git a/website/_docs31/howto/howto_use_restapi.md
b/website/_docs31/howto/howto_use_restapi.md
index 6997a8a..32c6b71 100644
--- a/website/_docs31/howto/howto_use_restapi.md
+++ b/website/_docs31/howto/howto_use_restapi.md
@@ -51,6 +51,9 @@ This page lists the major RESTful APIs provided by Kylin.
* [Get users cannot query the table](#get-users-cannot-query-the-table)
* [Put user to table blacklist](#put-user-to-table-blacklist)
* [Delete user from table blacklist](#delete-user-from-table-blacklist)
+* Metrics
+ * [Get all metrics](#get-all-metrics)
+ * [Get specific type of metrics](#get-specific-type-of-metrics)
## Authentication
`POST /kylin/api/user/authentication`
@@ -1493,6 +1496,28 @@ This API is specific for stream cube's building;
* table - `required` `string` table name
* name - `required` `string` user name or group name you want to delete from
table blacklist
+***
+
+## Get all metrics
+`GET /kylin/api/jmetrics/`
+
+#### Response sample
+```
+{
+ "version": "3.0.0",
+ "gauges": {},
+ "counters": {},
+ "histograms": {},
+ "meters": {},
+ "timers": {}
+}
+```
+
+## Get specific type of metrics
+`GET /kylin/api/jmetrics/{type}`
+
+#### Path variable
+* type - `required` `string` Specific type of metrics you want, e.g meters
## Use RESTful API in Javascript
diff --git a/website/_docs31/tutorial/setup_systemcube.cn.md
b/website/_docs31/tutorial/setup_systemcube.cn.md
index e4d2aea..fa16f6a 100644
--- a/website/_docs31/tutorial/setup_systemcube.cn.md
+++ b/website/_docs31/tutorial/setup_systemcube.cn.md
@@ -20,19 +20,14 @@ permalink: /cn/docs31/tutorial/setup_systemcube.html
```
[
- [
- "org.apache.kylin.tool.metrics.systemcube.util.HiveSinkTool",
{
- "storage_type": 2,
- "cube_desc_override_properties": [
- "java.util.HashMap",
- {
- "kylin.cube.algorithm": "INMEM",
- "kylin.cube.max-building-segments": "1"
- }
- ]
+ "sink": "hive",
+ "storage_type": 2,
+ "cube_desc_override_properties": {
+ "kylin.cube.algorithm": "INMEM",
+ "kylin.cube.max-building-segments": "1"
+ }
}
- ]
]
```
@@ -118,6 +113,16 @@ sh ${KYLIN_HOME}/bin/kylin.sh
org.apache.kylin.tool.job.CubeBuildingCLI --cube $
{% endhighlight %}
+## 自动创建系统cube
+
+从kylin 2.6.0开始提供system-cube.sh脚本，用户可以通过执行此脚本来自动创建系统cube。
+
+- 创建系统cube：`sh system-cube.sh setup`
+
+- 构建系统cube：`sh bin/system-cube.sh build`
+
+- 为系统cube添加定时任务：`bin/system.sh cron`
+
## 系统 Cube 的细节
### 普通 Dimension
diff --git a/website/_docs31/tutorial/setup_systemcube.md
b/website/_docs31/tutorial/setup_systemcube.md
index 6cf7b9e..e908b73 100644
--- a/website/_docs31/tutorial/setup_systemcube.md
+++ b/website/_docs31/tutorial/setup_systemcube.md
@@ -20,19 +20,14 @@ For example:
```
[
- [
- "org.apache.kylin.tool.metrics.systemcube.util.HiveSinkTool",
{
- "storage_type": 2,
- "cube_desc_override_properties": [
- "java.util.HashMap",
- {
- "kylin.cube.algorithm": "INMEM",
- "kylin.cube.max-building-segments": "1"
- }
- ]
+ "sink": "hive",
+ "storage_type": 2,
+ "cube_desc_override_properties": {
+ "kylin.cube.algorithm": "INMEM",
+ "kylin.cube.max-building-segments": "1"
+ }
}
- ]
]
```
@@ -118,6 +113,16 @@ sh ${KYLIN_HOME}/bin/kylin.sh
org.apache.kylin.tool.job.CubeBuildingCLI --cube $
{% endhighlight %}
+## Automatically create System Cube
+
+Kylin provides system-cube.sh from v2.6.0, users can automatically create
system cube by executing this script.
+
+- Create System Cube：`sh system-cube.sh setup`
+
+- Build System Cube：`sh bin/system-cube.sh build`
+
+- Add crontab job for System Cube：`bin/system.sh cron`
+
## Details of System Cube
### Common Dimension
