Merge pull request #126 from ZHAOYINRUI/patch-8

Create alarm_rules.md

.gitignore

@@ -56,6 +56,7 @@ fabric.properties
 *.jar
 *.war
 *.ear
+*.tar.gz
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
@@ -99,14 +100,14 @@ target/
 */velocity.log*
 */*.log
 */*.log.*
-web/node_modules/
+node_modules/
-web/node_modules/*
+node_modules/*
 workspace.xml
 /output/*
 .gitversion
-*/node_modules/*
+node_modules/*
-web/src/main/resources/templates/*
+out/*
-*/out/*
+dist/
-*/dist/*
+dist/*
+kafka-manager-web/src/main/resources/templates/
 .DS_Store
-kafka-manager-web/src/main/resources/templates/*

README.md

@@ -9,6 +9,8 @@
 
 ## 主要功能特性
 
+### 快速体验
+- 体验地址 http://117.51.146.109:8080 账号密码 admin/admin
 
 ### 集群监控维度
 
@@ -32,26 +34,30 @@
 
 ## kafka-manager架构图
 
-![kafka-manager-arch](./docs/assets/images/common/arch.png)
+![kafka-manager-arch](https://img-ys011.didistatic.com/static/dicloudpub/do1_xgDHNDLj2ChKxctSuf72)
 
 
 ## 相关文档
 
-- [kafka-manager安装手册](./docs/install_cn_guide.md)
+- [kafka-manager 安装手册](docs/install_guide/install_guide_cn.md)
-- [kafka-manager接入集群](./docs/manual_kafka_op/add_cluster.md)
+- [kafka-manager 接入集群](docs/user_guide/add_cluster/add_cluster.md)
-- [kafka-manager使用手册-待更新](./docs/user_cn_guide.md)
+- [kafka-manager 用户使用手册](docs/user_guide/user_guide_cn.md)
-
+- [kafka-manager FAQ](docs/user_guide/faq.md)
 
 ## 钉钉交流群
 
 ![dingding_group](./docs/assets/images/common/dingding_group.jpg)
+  钉钉群ID：32821440
+  
+## OCE认证
+OCE是一个认证机制和交流平台，为Logi-KafkaManager生产用户量身打造，我们会为OCE企业提供更好的技术支持，比如专属的技术沙龙、企业一对一的交流机会、专属的答疑群等，如果贵司Logi-KafkaManager上了生产，[快来加入吧](http://obsuite.didiyun.com/open/openAuth)
 
 
 ## 项目成员
 
 ### 内部核心人员
 
-`iceyuhui`、`liuyaguang`、`limengmonty`、`zhangliangmike`、`nullhuangyiming`、`zengqiao`、`eilenexuzhe`、`huangjiaweihjw`
+`iceyuhui`、`liuyaguang`、`limengmonty`、`zhangliangmike`、`nullhuangyiming`、`zengqiao`、`eilenexuzhe`、`huangjiaweihjw`、`zhaoyinrui`、`marzkonglingxu`、`joysunchao`
 
 
 ### 外部贡献者

build.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+workspace=$(cd $(dirname $0) && pwd -P)
+cd $workspace
+
+## constant
+OUTPUT_DIR=./output
+KM_VERSION=2.1.0
+APP_NAME=kafka-manager-$KM_VERSION
+
+MYSQL_TABLE_SQL_FILE=./docs/install_guide/create_mysql_table.sql
+CONFIG_FILE=./kafka-manager-web/src/main/resources/application.yml
+
+## function
+function build() {
+    # 编译命令
+	  mvn -U clean package -Dmaven.test.skip=true
+
+    local sc=$?
+    if [ $sc -ne 0 ];then
+    	## 编译失败, 退出码为 非0
+        echo "$APP_NAME build error"
+        exit $sc
+    else
+        echo "$APP_NAME build ok"
+    fi
+}
+
+function make_output() {
+    # 新建output目录
+    rm -rf ${OUTPUT_DIR} &>/dev/null
+    mkdir -p ${OUTPUT_DIR}/${APP_NAME} &>/dev/null
+
+    # 填充output目录, output内的内容
+    (
+          cp -rf ${MYSQL_TABLE_SQL_FILE} ${OUTPUT_DIR}/${APP_NAME} &&       # 拷贝 sql 初始化脚本      至output目录
+          cp -rf ${CONFIG_FILE} ${OUTPUT_DIR}/${APP_NAME} &&                # 拷贝 application.yml   至output目录
+
+          # 拷贝程序包到output路径
+          cp kafka-manager-web/target/kafka-manager-web-${KM_VERSION}-SNAPSHOT.jar ${OUTPUT_DIR}/${APP_NAME}/${APP_NAME}-SNAPSHOT.jar
+          echo -e "make output ok."
+    ) || { echo -e "make output error"; exit 2; } # 填充output目录失败后, 退出码为 非0
+}
+
+function make_package() {
+	# 压缩output目录
+	(
+	    cd ${OUTPUT_DIR} && tar cvzf ${APP_NAME}.tar.gz ${APP_NAME}
+      echo -e "make package ok."
+	) || { echo -e "make package error"; exit 2; } # 压缩output目录失败后, 退出码为 非0
+}
+
+##########################################
+## main
+## 其中,
+## 		1.进行编译
+##		2.生成部署包output
+##		3.生成tar.gz压缩包
+##########################################
+
+# 1.进行编译
+build
+
+# 2.生成部署包output
+make_output
+
+# 3.生成tar.gz压缩包
+make_package
+
+# 编译成功
+echo -e "build done"
+exit 0

docs/dev_guide/dynamic_config_manager.md

@@ -0,0 +1,65 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 动态配置管理
+
+## 1、Topic定时同步任务
+
+### 1.1、配置的用途
+`Logi-KafkaManager`在设计上，所有的资源都是挂在应用(app)下面。 如果接入的Kafka集群已经存在Topic了，那么会导致这些Topic不属于任何的应用，从而导致很多管理上的不便。
+
+因此，需要有一个方式将这些无主的Topic挂到某个应用下面。
+
+这里提供了一个配置，会定时自动将集群无主的Topic挂到某个应用下面下面。
+
+### 1.2、相关实现
+
+就是一个定时任务，该任务会定期做同步的工作。具体代码的位置在`com.xiaojukeji.kafka.manager.task.dispatch.op`包下面的`SyncTopic2DB`类。
+
+### 1.3、配置说明
+
+**步骤一：开启该功能**
+
+在application.yml文件中，增加如下配置，已经有该配置的话，直接把false修改为true即可
+```yml
+# 任务相关的开关
+task:
+  op:
+    sync-topic-enabled: true # 无主的Topic定期同步到DB中
+```
+
+**步骤二：配置管理中指定挂在那个应用下面**
+
+配置的位置：
+
+![sync_topic_to_db](./assets/dynamic_config_manager/sync_topic_to_db.jpg)
+
+配置键：`SYNC_TOPIC_2_DB_CONFIG_KEY`
+
+配置值(JSON数组)：
+- clusterId：需要进行定时同步的集群ID
+- defaultAppId：该集群无主的Topic将挂在哪个应用下面
+- addAuthority：是否需要加上权限, 默认是false。因为考虑到这个挂载只是临时的，我们不希望用户使用这个App，同时后续可能移交给真正的所属的应用，因此默认是不加上权限。
+
+**注意，这里的集群ID，或者是应用ID不存在的话，会导致配置不生效。该任务对已经在DB中的Topic不会进行修改**
+```json
+[
+  {
+    "clusterId": 1234567, 
+    "defaultAppId": "ANONYMOUS",
+    "addAuthority": false
+  },
+  {
+    "clusterId": 7654321,
+    "defaultAppId": "ANONYMOUS",
+    "addAuthority": false
+  }
+]
+```
+

docs/dev_guide/monitor_system_integrate_with_n9e.md

@@ -0,0 +1,42 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 监控系统集成——夜莺
+
+- `Kafka-Manager`通过将 监控的数据 以及 监控的规则 都提交给夜莺，然后依赖夜莺的监控系统从而实现监控告警功能。
+
+- 监控数据上报 & 告警规则的创建等能力已经具备。但类似查看告警历史，告警触发时的监控数据等正在集成中(暂时可以到夜莺系统进行查看)，欢迎有兴趣的同学进行共建 或 贡献代码。
+
+## 1、配置说明
+
+```yml
+# 配置文件中关于监控部分的配置
+monitor:
+  enabled: false
+  n9e:
+    nid: 2
+    user-token: 123456
+    # 夜莺 mon监控服务 地址
+    mon:
+      base-url: http://127.0.0.1:8006
+    # 夜莺 transfer上传服务 地址
+    sink:
+      base-url: http://127.0.0.1:8008
+    # 夜莺 rdb资源服务 地址
+    rdb:
+      base-url: http://127.0.0.1:80
+
+# enabled: 表示是否开启监控告警的功能, true: 开启, false: 不开启
+# n9e.nid: 夜莺的节点ID
+# n9e.user-token: 用户的密钥，在夜莺的个人设置中
+# n9e.mon.base-url: 监控地址
+# n9e.sink.base-url: 数据上报地址
+# n9e.rdb.base-url: 用户资源中心地址
+```
+

docs/dev_guide/monitor_system_integrate_with_self.md

@@ -0,0 +1,54 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 监控系统集成
+
+- 监控系统默认与 [夜莺] (https://github.com/didi/nightingale) 进行集成；
+- 对接自有的监控系统需要进行简单的二次开发，即实现部分监控告警模块的相关接口即可；
+- 集成会有两块内容，一个是指标数据上报的集成，还有一个是监控告警规则的集成；
+
+## 1、指标数据上报集成
+
+仅完成这一步的集成之后，即可将监控数据上报到监控系统中，此时已能够在自己的监控系统进行监控告警规则的配置了。
+
+**步骤一：实现指标上报的接口**
+
+- 按照自己内部监控系统的数据格式要求，将数据进行组装成符合自己内部监控系统要求的数据进行上报，具体的可以参考夜莺集成的实现代码。
+- 至于会上报哪些指标，可以查看有哪些地方调用了该接口。
+
+![sink_metrics](./assets/monitor_system_integrate_with_self/sink_metrics.jpg)
+
+**步骤二：相关配置修改**
+
+![change_config](./assets/monitor_system_integrate_with_self/change_config.jpg)
+
+**步骤三：开启上报任务**
+
+![open_sink_schedule](./assets/monitor_system_integrate_with_self/open_sink_schedule.jpg)
+
+
+## 2、监控告警规则集成
+
+完成**1、指标数据上报集成**之后，即可在自己的监控系统进行监控告警规则的配置了。完成该步骤的集成之后，可以在`Logi-KafkaManager`中进行监控告警规则的增删改查等等。
+
+大体上和**1、指标数据上报集成**一致，
+
+**步骤一：实现相关接口**
+
+![integrate_ms](./assets/monitor_system_integrate_with_self/integrate_ms.jpg)
+
+实现完成步骤一之后，接下来的步骤和**1、指标数据上报集成**中的步骤二、步骤三一致，都需要进行相关配置的修改即可。
+
+
+## 3、总结
+
+简单介绍了一下监控告警的集成，嫌麻烦的同学可以仅做 **1、指标数据上报集成** 这一节的内容即可满足一定场景下的需求。
+
+
+**集成过程中，有任何觉得文档没有说清楚的地方或者建议，欢迎入群交流，也欢迎贡献代码，觉得好也辛苦给个star。**

docs/dev_guide/use_mysql_8.md

@@ -0,0 +1,41 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 使用`MySQL 8`
+
+感谢 [herry-hu](https://github.com/herry-hu) 提供的方案。
+
+
+当前因为无法同时兼容`MySQL 8`与`MySQL 5.7`，因此代码中默认的版本还是`MySQL 5.7`。
+
+
+当前如需使用`MySQL 8`，则续按照下述流程进行简单修改代码。
+
+
+- Step1. 修改application.yml中的MySQL驱动类
+```shell
+
+# 将driver-class-name后面的驱动类修改为:
+# driver-class-name: com.mysql.jdbc.Driver
+driver-class-name: com.mysql.cj.jdbc.Driver
+```
+
+
+- Step2. 修改MySQL依赖包
+```shell
+# 将根目录下面的pom.xml文件依赖的`MySQL`依赖包版本调整为
+
+<dependency>
+    <groupId>mysql</groupId>
+    <artifactId>mysql-connector-java</artifactId>
+#    <version>5.1.41</version>
+    <version>8.0.20</version>
+</dependency>
+```
+

docs/install_cn_guide.md

@@ -1,58 +0,0 @@
-
----
-
-![kafka-manager-logo](./assets/images/common/logo_name.png)
-
-**一站式`Apache Kafka`集群指标监控与运维管控平台**
-
---- 
-
-# 安装手册
-
-
-## 环境依赖
-
-- `Maven 3.2+`(后端打包依赖)
-- `node 10+`(前端打包依赖)
-- `Java 8+`(运行环境需要)
-- `MySQL`(数据存储)
-
----
-
-## 环境初始化
-
-执行[create_mysql_table.sql](./create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`kafka_manager`。
-
-```
-# 示例：
-mysql -uXXXX -pXXX -h XXX.XXX.XXX.XXX -PXXXX < ./create_mysql_table.sql
-```
-
----
-
-## 打包
-
-```bash
-
-# 一次性打包
-cd ..
-mvn install
-
-```
-
----
-
-## 启动
-
-```
-# application.yml 是配置文件
-
-cp web/src/main/resources/application.yml web/target/
-cd web/target/
-nohup java -jar kafka-manager-web-2.0.0-SNAPSHOT.jar --spring.config.location=./application.yml > /dev/null 2>&1 &
-```
-
-## 使用
-
-本地启动的话，访问`http://localhost:8080`，输入帐号及密码进行登录。更多参考：[kafka-manager使用手册](./user_cn_guide.md)
-

docs/install_guide/config_description.md

@@ -0,0 +1,104 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 配置说明
+
+```yaml
+server:
+  port: 8080  # 服务端口
+  tomcat:
+    accept-count: 1000
+    max-connections: 10000
+    max-threads: 800
+    min-spare-threads: 100
+
+spring:
+  application:
+    name: kafkamanager
+  datasource:
+    kafka-manager: # 数据库连接配置
+      jdbc-url: jdbc:mysql://127.0.0.1:3306/kafka_manager?characterEncoding=UTF-8&serverTimezone=GMT%2B8  #数据库的地址
+      username: admin # 用户名
+      password: admin # 密码
+      driver-class-name: com.mysql.jdbc.Driver
+  main:
+    allow-bean-definition-overriding: true
+
+  profiles:
+    active: dev # 启用的配置
+  servlet:
+    multipart:
+      max-file-size: 100MB
+      max-request-size: 100MB
+
+logging:
+  config: classpath:logback-spring.xml
+
+custom:
+  idc: cn # 部署的数据中心, 忽略该配置, 后续会进行删除
+  jmx:
+    max-conn: 10 # 和单台 broker 的最大JMX连接数 
+  store-metrics-task:
+    community:
+      broker-metrics-enabled: true # 社区部分broker metrics信息收集开关, 关闭之后metrics信息将不会进行收集及写DB
+      topic-metrics-enabled: true # 社区部分topic的metrics信息收集开关, 关闭之后metrics信息将不会进行收集及写DB
+    didi:
+      app-topic-metrics-enabled: false # 滴滴埋入的指标, 社区AK不存在该指标，因此默认关闭
+      topic-request-time-metrics-enabled: false # 滴滴埋入的指标, 社区AK不存在该指标，因此默认关闭
+      topic-throttled-metrics: false # 滴滴埋入的指标, 社区AK不存在该指标，因此默认关闭
+    save-days: 7 #指标在DB中保持的天数，-1表示永久保存，7表示保存近7天的数据
+
+# 任务相关的开关
+task:
+  op:
+    sync-topic-enabled: false # 未落盘的Topic定期同步到DB中
+
+account: # ldap相关的配置, 社区版本暂时支持不够完善，可以先忽略，欢迎贡献代码对这块做优化
+  ldap:
+
+kcm: # 集群升级部署相关的功能，需要配合夜莺及S3进行使用，这块我们后续专门补充一个文档细化一下，牵扯到kcm_script.sh脚本的修改
+  enabled: false # 默认关闭
+  storage:
+    base-url: http://127.0.0.1 # 存储地址
+  n9e:
+    base-url: http://127.0.0.1:8004 # 夜莺任务中心的地址
+    user-token: 12345678 # 夜莺用户的token
+    timeout: 300 # 集群任务的超时时间，单位秒
+    account: root # 集群任务使用的账号
+    script-file: kcm_script.sh # 集群任务的脚本
+
+monitor: # 监控告警相关的功能，需要配合夜莺进行使用
+  enabled: false # 默认关闭，true就是开启
+  n9e:
+    nid: 2
+    user-token: 1234567890
+    mon:
+      # 夜莺 mon监控服务 地址
+      base-url: http://127.0.0.1:8032
+    sink:
+      # 夜莺 transfer上传服务 地址
+      base-url: http://127.0.0.1:8006
+    rdb:
+      # 夜莺 rdb资源服务 地址
+      base-url: http://127.0.0.1:80
+
+# enabled: 表示是否开启监控告警的功能, true: 开启, false: 不开启
+# n9e.nid: 夜莺的节点ID
+# n9e.user-token: 用户的密钥，在夜莺的个人设置中
+# n9e.mon.base-url: 监控地址
+# n9e.sink.base-url: 数据上报地址
+# n9e.rdb.base-url: 用户资源中心地址
+
+notify: # 通知的功能
+  kafka: # 默认通知发送到kafka的指定Topic中
+    cluster-id: 95 # Topic的集群ID
+    topic-name: didi-kafka-notify # Topic名称
+  order: # 部署的KM的地址
+    detail-url: http://127.0.0.1
+```

docs/install_guide/create_mysql_table.sql

@@ -36,7 +36,6 @@ CREATE TABLE `app` (
   UNIQUE KEY `uniq_name` (`name`),
   UNIQUE KEY `uniq_app_id` (`app_id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='应用信息';
-INSERT INTO app(app_id, name, password, type, applicant, principals, description) VALUES ('km-admin-tmp', 'km-admin-tmp', '123456', 0, 'admin', 'admin', '临时应用');
 
 
 --
@@ -204,6 +203,11 @@ CREATE TABLE `gateway_config` (
   PRIMARY KEY (`id`),
   UNIQUE KEY `uniq_type_name` (`type`,`name`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='gateway配置';
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_QUEUE_SIZE', 'SERVICE_DISCOVERY_QUEUE_SIZE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_APPID_RATE', 'SERVICE_DISCOVERY_APPID_RATE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_IP_RATE', 'SERVICE_DISCOVERY_IP_RATE', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_SP_RATE', 'app_01234567', 100000000, 1);
+INSERT INTO gateway_config(type, name, value, `version`) values('SERVICE_DISCOVERY_SP_RATE', '192.168.0.1', 100000000, 1);
 
 --
 -- Table structure for table `heartbeat`
@@ -290,6 +294,9 @@ CREATE TABLE `kafka_user` (
   `create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
   PRIMARY KEY (`id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='kafka用户表';
+INSERT INTO app(app_id, name, password, type, applicant, principals, description) VALUES ('dkm_admin', 'KM管理员', 'km_kMl4N8as1Kp0CCY', 1, 'admin', 'admin', 'KM管理员应用-谨慎对外提供');
+INSERT INTO kafka_user(app_id, password, user_type, operation) VALUES ('dkm_admin', 'km_kMl4N8as1Kp0CCY', 1, 0);
+
 
 --
 -- Table structure for table `logical_cluster`

docs/install_guide/install_guide_cn.md

@@ -0,0 +1,58 @@
+
+---
+
+![kafka-manager-logo](../assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 安装手册
+
+
+## 环境依赖
+
+- `Maven 3.5+`(后端打包依赖)
+- `node v12+`(前端打包依赖)
+- `Java 8+`(运行环境需要)
+- `MySQL 5.7`(数据存储)
+
+---
+
+## 环境初始化
+
+执行[create_mysql_table.sql](create_mysql_table.sql)中的SQL命令，从而创建所需的MySQL库及表，默认创建的库名是`kafka_manager`。
+
+```
+# 示例：
+mysql -uXXXX -pXXX -h XXX.XXX.XXX.XXX -PXXXX < ./create_mysql_table.sql
+```
+
+---
+
+## 打包
+
+```bash
+
+# 一次性打包
+cd ..
+mvn install
+
+```
+
+---
+
+## 启动
+
+```
+# application.yml 是配置文件
+
+cp kafka-manager-web/src/main/resources/application.yml kafka-manager-web/target/
+cd kafka-manager-web/target/
+nohup java -jar kafka-manager-web-2.1.0-SNAPSHOT.jar --spring.config.location=./application.yml > /dev/null 2>&1 &
+```
+
+## 使用
+
+本地启动的话，访问`http://localhost:8080`，输入帐号及密码(默认`admin/admin`)进行登录。更多参考：[kafka-manager 用户使用手册](../user_guide/user_guide_cn.md)
+

docs/user_cn_guide.md

@@ -1,166 +0,0 @@
-
----
-
-![kafka-manger-logo](./assets/images/common/logo_name.png)
-
-**一站式`Apache Kafka`集群指标监控与运维管控平台**
-
---- 
-
-# kafka-manager 使用手册
-
-管控平台主要有两种用户视角，分别为：
-
-- 普通用户：站在使用Kafka的角度使用kafka-manager；
-- 管理员：站在使用与管理Kafka的角度在使用kafka-manager；
-
-下面我们将从这两个用户的维度说明平台的功能及使用。
-
----
-
-## 1. 普通用户篇
-
-### 1.1 帐号获取及登录
-
-- 询问管理员让其提供普通用户的帐号；
-- 输入帐号及密码，登录kafka-manager；
-
----
-
-### 1.2 Topic申请
-- 步骤一：点击"Topic申请"按钮申请Topic；
-- 步骤二：填写申请信息；
-- 步骤三：等待运维人员或管理员审批；
-
-**Topic申请完成：**
-![my_order_list](./assets/images/kafka_manager_cn_guide/my_order_list.jpg)
-
---- 
-
-### 1.3 Topic信息查看
-
-普通用户可查看的信息包括：
-
-- 集群Topic列表及我收藏的Topic列表；
-- Topic基本信息(Topic创建及修改时间、Topic数据保存时间、Topic负责人等)；
-- Topic分区信息；
-- Topic消费组信息及消费组消费详情；
-- Topic实时&历史流量信息；
-- Topic数据采样；
-
-**Topic详情信息界面：**
-![normal_topic_detail](./assets/images/kafka_manager_cn_guide/normal_topic_detail.jpg)
-
----
-
-### 1.4 Topic运维
-
-普通用户可进行的Topic运维的操作包括：
-- 申请Topic扩容
-- 重置消费偏移；
-
-**Topic重置消费偏移界面：**
-![normal_reset_consume_offset](./assets/images/kafka_manager_cn_guide/normal_reset_consume_offset.jpg)
-
----
-
-### 1.5 告警配置
-
-kafka-manager告警配置中，仅支持Lag／BytesIn/BytesOut这三类告警，同时告警被触发后，告警消息会被发往指定的Topic(具体哪一个请联系管理员获取)。需要用户主动消费该告警Topic的数据或者统一由管理员将该数据接入外部通知系统，比如接入短信通知或电话通知等。
-
-**告警规则配置界面：**
-![normal_create_alarm_rule](./assets/images/kafka_manager_cn_guide/normal_create_alarm_rule.jpg)
-
----
-
-### 1.6 密码修改
-
-**密码修改界面：**
-![normal_modify_password](./assets/images/kafka_manager_cn_guide/normal_modify_password.jpg)
-
----
-
-## 2. 管理员篇
-
-
-### 2.1 帐号获取及登录
-
-- 默认的管理员帐号密码为`admin/admin`(详见数据库account表)；
-
----
-
-### 2.2 添加集群
-
-登录之后，就需要将我们搭建的Kafka集群添加到kafka-manager中。
-
-**添加Kafka集群界面：**
-![admin_add_cluster](./assets/images/kafka_manager_cn_guide/admin_add_cluster.jpg)
-
---- 
-
-### 2.3 监控指标
-
-#### 2.3.1 集群维度指标
-
-- 集群的基本信息；
-- 集群历史及实时流量信息；
-- 集群Topic信息；
-- 集群Broker信息；
-- 集群ConsumerGroup信息；
-- 集群Region信息；
-- 集群当前Controller及变更历史；
-
-**集群维度监控指标界面：**
-![admin_cluster_details](./assets/images/kafka_manager_cn_guide/admin_cluster_details.jpg)
-
----
-
-#### 2.3.2 Broker维度指标
-
-- Broker基本信息；
-- Broker历史与实时流量信息；
-- Broker内Topic信息；
-- Broker内分区信息；
-- Broker关键指标(日志刷盘时间等)；
-- Topic分析(Topic流量占比等)；
-
-**`Broker`维度监控指标界面：**
-![admin_cluster_broker_detail](./assets/images/kafka_manager_cn_guide/admin_cluster_broker_detail.jpg)
-
----
-
-#### 2.3.3 Topic维度指标
-
-- 在普通用户的基础上，增加展示Topic的Broker信息；
-
-图略
-
----
-
-#### 2.3.4 其他维度指标
-
-- 消费组消费哪些具体的Topic；
-
-图略
-
----
-
-### 2.4 集群运维管控
-
-- Topic申请及扩容工单审批；
-- Topic创建、删除、扩容及属性修改；
-- Broker维度优先副本选举；
-- 分区粒度迁移；
-- 逻辑Region管理；
-
-**资源审批界面：**
-![admin_order](./assets/images/kafka_manager_cn_guide/admin_order.jpg)
-
----
-
-### 2.5 用户管理
-
-- 对用户进行增删改查；
-
-**用户管理界面：**
-![admin_manager_account](./assets/images/kafka_manager_cn_guide/admin_manager_account.jpg)

docs/user_guide/add_cluster/add_cluster.md

@@ -1,7 +1,7 @@
 
 ---
 
-![kafka-manager-logo](../assets/images/common/logo_name.png)
+![kafka-manager-logo](../../assets/images/common/logo_name.png)
 
 **一站式`Apache Kafka`集群指标监控与运维管控平台**
 
@@ -19,13 +19,13 @@
 
 ## 1、接入物理集群
 
-![op_add_cluster](./imgs/op_add_cluster.jpg)
+![op_add_cluster](assets/op_add_cluster.jpg)
 
 如上图所示，填写集群信息，然后点击确定，即可完成集群的接入。因为考虑到分布式部署，添加集群之后，需要稍等**`1分钟`**才可以在界面上看到集群的详细信息。
 
 ## 2、创建Region
 
-![op_add_region](./imgs/op_add_region.jpg)
+![op_add_region](assets/op_add_region.jpg)
 
 如上图所示，填写Region信息，然后点击确定，即可完成Region的创建。
 
@@ -33,7 +33,7 @@
 
 ## 3、创建逻辑集群
 
-![op_add_logical_cluster](./imgs/op_add_logical_cluster.jpg)
+![op_add_logical_cluster](assets/op_add_logical_cluster.jpg)
 
 
 如上图所示，填写逻辑集群信息，然后点击确定，即可完成逻辑集群的创建。

docs/user_guide/alarm_rules.md

@@ -0,0 +1,25 @@
+![kafka-manager-logo](../assets/images/common/logo_name.png))
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+---
+
+
+## 报警策略-报警函数介绍
+
+
+
+| 类别 | 函数 | 含义 |函数文案 |备注  |
+| --- | --- | --- | --- | --- |
+| 发生次数 |all，n  | 最近$n个周期内，全发生 | 连续发生(all) |  |
+| 发生次数 | happen, n, m | 最近$n个周期内，发生m次 | 出现(happen) | null点也计算在n内 |
+| 数学统计 | 	sum, n | 最近$n个周期取值 的 和 | 求和(sum) | sum_over_time |
+| 数学统计 | avg, n | 最近$n个周期取值 的 平均值 | 平均值(avg) | avg_over_time |
+| 数学统计 | min, n | 最近$n个周期取值 的 最小值 | 最小值(min) | min_over_time |
+| 数学统计	 | max, n | 最近$n个周期取值 的 最大值 | 最大值(max | max_over_time |
+| 变化率 | pdiff, n | 最近$n个点的变化率, 有一个满足 则触发 | 突增突降率(pdiff) | 假设, 最近3个周期的值分别为 v, v2, v3（v为最新值）那么计算公式为 any( (v-v2)/v2, (v-v3)/v3 )**区分正负** |
+| 变化量 | diff, n | 最近$n个点的变化量, 有一个满足 则触发 | 突增突降值(diff) | 假设, 最近3个周期的值分别为 v, v2, v3（v为最新值）那么计算公式为 any( (v-v2), (v-v3) )**区分正负** |
+| 变化量 | ndiff | 最近n个周期，发生m次 v(t) - v(t-1) $OP threshold其中 v(t) 为最新值 | 连续变化（区分正负） - ndiff	 |  |
+| 数据中断 | nodata, t | 最近 $t 秒内 无数据上报 | 数据上报中断(nodata) |  |
+| 同环比 | c_avg_rate_abs, n | 最近$n个周期的取值，相比 1天或7天前取值 的变化率 的绝对值 | 同比变化率(c_avg_rate_abs) | 假设最近的n个值为 v1, v2, v3历史取到的对应n'个值为 v1', v2'那么计算公式为abs((avg(v1,v2,v3) / avg(v1',v2') -1)* 100%) |
+| 同环比 | c_avg_rate, n | 最近$n个周期的取值，相比 1天或7天前取值 的变化率（**区分正负**) | 同比变化率(c_avg_rate) | 假设最近的n个值为 v1, v2, v3历史取到的对应n'个值为 v1', v2'那么计算公式为(avg(v1,v2,v3) / avg(v1',v2') -1)* 100% |