layout: docs31-cn title: 建立系统 Cube categories: tutorial permalink: /cn/docs31/tutorial/setup_systemcube.html

自 Apache Kylin v2.3.0 起有效

本节主要内容：

  • [什么是系统 Cube](#什么是系统 Cube)
  • [如何建立系统 Cube](#如何建立系统 Cube)
  • [自动创建系统 Cube](#自动创建系统 Cube)
  • [系统 Cube 的细节](#系统 Cube 的细节)

什么是系统 Cube

为了更好的支持自我监控，在系统 project 下创建一组系统 Cubes，叫做 “KYLIN_SYSTEM”。现在，这里有五个 Cubes。三个用于查询指标，“METRICS_QUERY”，“METRICS_QUERY_CUBE”，“METRICS_QUERY_RPC”。另外两个是 job 指标，“METRICS_JOB”，“METRICS_JOB_EXCEPTION”。

如何建立系统 Cube

本节我们介绍手动启用系统 Cube 的方法，如果您希望通过 shell 脚本自动创建系统 Cube，请参考[自动创建系统 Cube](#自动创建系统 Cube)。

1. 准备

在 KYLIN_HOME 目录下创建一个配置文件 SCSinkTools.json。例如：

[
    {
       "sink": "hive",
       "storage_type": 2,
       "cube_desc_override_properties": {
         "kylin.cube.algorithm": "INMEM",
         "kylin.cube.max-building-segments": "1"
       }
    }
]

2. 生成 Metadata

在 KYLIN_HOME 文件夹下运行以下命令生成相关的 metadata：

./bin/kylin.sh org.apache.kylin.tool.metrics.systemcube.SCCreator \
-inputConfig SCSinkTools.json \
-output <output_forder>

通过这个命令，相关的 metadata 将会生成且其位置位于 <output_forder> 下。细节如下，system_cube 就是我们的 <output_forder>：

metadata

3. 建立数据源

运行下列命令生成 Hive 源表：

hive -f <output_forder>/create_hive_tables_for_system_cubes.sql

通过这个命令，相关的 hive 表将会被创建。每一个系统 Cube 中的事实表对应了一张 Hive 源表，Hive 源表中记录了查询或任务相关的数据，这些数据将为系统 Cube 服务。

hive_table

4. 为系统 Cubes 上传 Metadata

然后我们需要通过下列命令上传 metadata 到 hbase：

./bin/metastore.sh restore <output_forder>

5. 重载 Metadata

最终，我们需要在 Kylin web UI 重载 metadata。然后，一组系统 Cubes 将会被创建在系统 project 下，称为 “KYLIN_SYSTEM”。

6. 构建系统 Cube

当系统 Cube 被创建，我们需要定期构建 Cube。方法如下：

步骤一：创建一个 shell 脚本，通过调用 org.apache.kylin.tool.job.CubeBuildingCLI 来构建系统 Cube。例如：

{% highlight Groff markup %} #!/bin/bash

dir=$(dirname ${0}) export KYLIN_HOME=${dir}/../

CUBE=$1 INTERVAL=$2 DELAY=$3 CURRENT_TIME_IN_SECOND=date +%s CURRENT_TIME=$((CURRENT_TIME_IN_SECOND * 1000)) END_TIME=$((CURRENT_TIME-DELAY)) END=$((END_TIME - END_TIME%INTERVAL))

ID=“$END” echo “building for ${CUBE}_${ID}” >> ${KYLIN_HOME}/logs/build_trace.log sh ${KYLIN_HOME}/bin/kylin.sh org.apache.kylin.tool.job.CubeBuildingCLI --cube ${CUBE} --endTime ${END} > ${KYLIN_HOME}/logs/system_cube_${CUBE}_${END}.log 2>&1 &

{% endhighlight %}

步骤二：定期运行这个 shell 脚本。例如，像接下来这样添加一个 cron job：

{% highlight Groff markup %} 0 */2 * * * sh ${KYLIN_HOME}/bin/system_cube_build.sh KYLIN_HIVE_METRICS_QUERY_QA 3600000 1200000

20 */2 * * * sh ${KYLIN_HOME}/bin/system_cube_build.sh KYLIN_HIVE_METRICS_QUERY_CUBE_QA 3600000 1200000

40 */4 * * * sh ${KYLIN_HOME}/bin/system_cube_build.sh KYLIN_HIVE_METRICS_QUERY_RPC_QA 3600000 1200000

30 */4 * * * sh ${KYLIN_HOME}/bin/system_cube_build.sh KYLIN_HIVE_METRICS_JOB_QA 3600000 1200000

50 */12 * * * sh ${KYLIN_HOME}/bin/system_cube_build.sh KYLIN_HIVE_METRICS_JOB_EXCEPTION_QA 3600000 12000

{% endhighlight %}

自动创建系统 Cube

从kylin 2.6.0 开始提供 system-cube.sh 脚本，用户可以通过执行此脚本来自动创建系统 Cube。

  • 创建系统 Cube：sh bin/system-cube.sh setup

  • 构建系统 Cube：sh bin/system-cube.sh build

  • 为系统 Cube 添加定时任务：sh bin/system-cube.sh cron

注意：System-cube.sh 会调用 ${KYLIN_HOME}/bin/build-incremental-cube.sh 脚本来提交构建任务，build-incremental-cube.sh 中默认使用 ADMIN:KYLIN 的用户名和密码作为 authtication 来调用 kylin 的 rebuild API，如果您修改了 ADMIN 用户的密码或者想使用 ADMIN 以外的用户来提交构建任务，请找到 build-incremental-cube.sh 中的 ADMIN:KYLIN，将其替换为正确的用户名和密码。

系统 Cube 的细节

Hive 中有 5 张表记录了 Kylin 系统的相关指标数据，每一个系统 Cube 的事实表对应了一张 Hive 表，共有 5 个系统 Cube。

普通 Dimension

对于这些系统 Cube，admins 能够用四个时间粒度查询，这些维度在 5 个系统 Cube 中均生效。从高级别到低级别，如下：

METRICS_QUERY

这个 Cube 用于在最高级别收集查询 metrics。细节如下：

METRICS_QUERY_RPC

这个 Cube 用于在最低级别收集查询 metrics。对于一个查询，相关的 aggregation 和 filter 能够下推到每一个 rpc 目标服务器。Rpc 目标服务器的健壮性是更好查询性能的基础。细节如下：

METRICS_QUERY_CUBE

这个 Cube 用于在 Cube 级别收集查询 metrics。最重要的是 cuboids 相关的，其为 Cube planner 提供服务。细节如下：

METRICS_JOB

在 Kylin 中，主要有三种类型的 job：

  • “BUILD”，为了从 HIVE 中 building Cube segments。
  • “MERGE”，为了在 HBASE 中 merging Cube segments。
  • “OPTIMIZE”，为了在 HBASE 中基于 base cuboid 动态调整预计算 cuboid tree。

这个 Cube 是用来收集 job 指标。细节如下：

METRICS_JOB_EXCEPTION

这个 Cube 是用来收集 job exception 指标。细节如下：