<commit_before>## KyAnalyzer 自助式敏捷BI工具

KyAnalyzer无缝集成KAP（Kylin），让用户以最简单快捷的方式访问KAP的数据。


###使用KyAnalyzer的前提条件
* KAP版本需为2.1或之后版本
* Apache Kylin版本需为1.5.4.1或之后版本
* KyAnalyzer暂不支持*left join*查询，使用者构建Cube模型时需指定join关系为*inner join*


### 安装
在[ KyAccount ]( http://account.kyligence.io/ )申请下载KyAnalyzer的安装包和许可证
解压kyanalyzer安装包，生成目录kyanalyzer-{version}
```tar-zxf KyAnalyzer-{version}.tar.gz```
将license文件kyAnalyzer.lic拷贝至kyanalyzer-{version}/conf下
```mv kyAnalyzer.lic kyanalyzer-{version}/conf```

在kyanalyzer-server-{version}/conf目录下有个配置文件kyanalyzer.properties， 需要在该文件中配置好KAP的IP及端口信息，*kap.host*为KAP的IP，默认为localhost，*kap.port*为KAP REST API的端口，默认7070。
同时，关于mondrian的所有配置可以参考conf/mondrian.properties.template 配置到mondrian.properties中。（注：在kap2.2之后，我们将kap.host及kap.port配置移到kyanalyzer.properties中，同时在conf下引入了mondrian.properties）

###启动

通过kyanalyzer-{version}目录下的 start-analyzer.sh启动KyAnalyzer
```sh start-analyzer.sh  ```
默认端口为8080,可通过 http://{hostname}:8080 访问页面。如果要停掉应用执行
```sh stop-analyzer.sh```

如果在启动过程中遇到问题页面打不开，可以到tomcat/logs目录下查看具体出错信息。
启动时通过tomcat/logs/catalina.out可以监控到启动时是否有错，如果端口冲突，请修改tomcat/conf/server.xml, 找到如下配置项

```$xslt
<Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
```
将`port`改为可用的端口即可。

根目录下文件信息

![](images/server_dir.png)

### 升级
KyAnalyzer的数据信息主要存储在根目录下的repository和data目录下，设要从在KyAnalyzer从在KyAnalyzer-1升级到在KyAnalyzer-2，升级步骤如下：

* 备份KyAnalyzer-1元数据
  + 在KyAnalyzer-1目录下创建备份文件夹，命令：`mkdir backup`
  + 运行命令`cp -r data repository ./backup/`将元数据备份至backup文件夹

* 恢复KyAnalyzer-2为KyAnalyzer-1元数据
  + 新安装KyAnalyzer为KyAnalyzer-2，设KyAnalyzer-2和KyAnalyzer-1目录分别为{KyAnalyzer-2}和{KyAnalyzer-1}
  + 在KyAnalyzer-2目录下，先删除KyAnalyzer-2的自带元数据文件夹，`rm -rf data repository`
  + 在KyAnalyzer-2目录下运行`cp -r ${KyAnalyzer-1}/backup/* ./`

###关于KyAnalyzer,KAP,Mondrian-Kylin 版本功能描述
<table>
    <tr>
    <th>KAP</th>
    <th>KyAnalyzer</th>
    <th>Mondrian-Kylin</th>
    <th>COUNT_DISTINCT</th>
    <th>TOP_N</th>
    <th>正常查询</th>
    <th></th>
    </tr>
    <tr>
        <td>2.0</td>
        <td>&gt;=2.1</td>
        <td>1.0</td>
        <td>❎</td>
        <td>❎</td>
        <td>✅</td>
        <td></td>
    </tr>
    <tr>
        <td>2.0</td>
        <td>&gt;=2.1</td>
        <td>1.1</td>
        <td>✅</td>
        <td>❎</td><commit_msg>upgrade web server config for KyAnalyzer<commit_after>## KyAnalyzer 自助式敏捷BI工具

KyAnalyzer无缝集成KAP（Kylin），让用户以最简单快捷的方式访问KAP的数据。


###使用KyAnalyzer的前提条件
* KAP版本需为2.1或之后版本
* Apache Kylin版本需为1.5.4.1或之后版本
* KyAnalyzer暂不支持*left join*查询，使用者构建Cube模型时需指定join关系为*inner join*


### 安装
在[ KyAccount ]( http://account.kyligence.io/ )申请下载KyAnalyzer的安装包和许可证
解压kyanalyzer安装包，生成目录kyanalyzer-{version}
```tar-zxf KyAnalyzer-{version}.tar.gz```
将license文件kyAnalyzer.lic拷贝至kyanalyzer-{version}/conf下
```mv kyAnalyzer.lic kyanalyzer-{version}/conf```

在kyanalyzer-server-{version}/conf目录下有个配置文件kyanalyzer.properties， 需要在该文件中配置好KAP的IP及端口信息，*kap.host*为KAP的IP，默认为localhost，*kap.port*为KAP REST API的端口，默认7070。
同时，关于mondrian的所有配置可以参考conf/mondrian.properties.template 配置到mondrian.properties中。（注：在kap2.2之后，我们将kap.host及kap.port配置移到kyanalyzer.properties中，同时在conf下引入了mondrian.properties）

###启动

通过kyanalyzer-{version}目录下的 start-analyzer.sh启动KyAnalyzer
```sh start-analyzer.sh  ```
默认端口为8080,可通过 http://{hostname}:8080 访问页面。如果要停掉应用执行
```sh stop-analyzer.sh```

如果在启动过程中遇到问题页面打不开，可以到tomcat/logs目录下查看具体出错信息。
启动时通过tomcat/logs/catalina.out可以监控到启动时是否有错，如果端口冲突，请修改tomcat/conf/server.xml, 找到如下配置项

```$xslt
<Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
```
将`port`改为可用的端口即可。

根目录下文件信息

![](images/server_dir.png)

### 升级
KyAnalyzer的数据信息主要存储在根目录下的repository和data目录下，设要从在KyAnalyzer从在KyAnalyzer-1升级到在KyAnalyzer-2，升级步骤如下：

* 备份KyAnalyzer-1元数据
  + 在KyAnalyzer-1目录下创建备份文件夹，命令：`mkdir backup`
  + 运行命令`cp -r data repository ./backup/`将元数据备份至backup文件夹

* 恢复KyAnalyzer-2为KyAnalyzer-1元数据
  + 新安装KyAnalyzer为KyAnalyzer-2，设KyAnalyzer-2和KyAnalyzer-1目录分别为{KyAnalyzer-2}和{KyAnalyzer-1}
  + 在KyAnalyzer-2目录下，先删除KyAnalyzer-2的自带元数据文件夹，`rm -rf data repository`
  + 在KyAnalyzer-2目录下运行`cp -r ${KyAnalyzer-1}/backup/* ./`
  
* 注意默认端口8080，可通过http://{hostname}:8080访问；如果需要修改端口，请同步修改tomcat/conf/server.xml文件或者将KyAnalyzer-1的server.xml文件复制到KyAnalyzer-2的tomcat/conf/server.xml。

###关于KyAnalyzer,KAP,Mondrian-Kylin 版本功能描述
<table>
    <tr>
    <th>KAP</th>
    <th>KyAnalyzer</th>
    <th>Mondrian-Kylin</th>
    <th>COUNT_DISTINCT</th>
    <th>TOP_N</th>
    <th>正常查询</th>
    <th></th>
    </tr>
    <tr>
        <td>2.0</td>
        <td>&gt;=2.1</td>
        <td>1.0</td>
        <td>❎</td>
        <td>❎</td>
        <td>✅</td>
        <td></td>
    </tr>
    <tr>
        <td>2.0</td>
        <td>&gt;=2.1</td>
        <td>1.1</td>
        <td>✅</td>
        <td>❎</td>
{'fraction_non_alphanumeric': 0.16035168515804898, 'fraction_numerical': 0.02805107808247854, 'mean_word_length': 4.491954022988506, 'pattern_counts': {'":': 0, '<': 93, '<?xml version=': 0, '>': 93, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 5}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '952992', 'n_tokens_mistral': 2645, 'n_tokens_neox': 2726, 'n_words': 199}