init

docs/create_mysql_table.sql

@@ -0,0 +1,241 @@
+CREATE DATABASE IF NOT EXISTS `kafka_manager`;
+
+USE `kafka_manager`;
+
+CREATE TABLE `account` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID',
+  `username` varchar(256) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '用户名',
+  `password` varchar(256) NOT NULL DEFAULT '' COMMENT '密码',
+  `role` int(16) NOT NULL DEFAULT '0' COMMENT '角色类型, 0:普通用户',
+  `status` int(16) NOT NULL DEFAULT '0' COMMENT '0标识使用中，-1标识已废弃',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_username` (`username`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='账号表';
+INSERT INTO account(username, password, role) VALUES ('admin', '21232f297a57a5a743894a0e4a801fc3', 2);
+
+
+CREATE TABLE `alarm_rule` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增ID',
+  `alarm_name` varchar(128) NOT NULL DEFAULT '' COMMENT '告警名字',
+  `strategy_expressions` text COMMENT '表达式',
+  `strategy_filters` text COMMENT '过滤条件',
+  `strategy_actions` text COMMENT '响应',
+  `principals` varchar(512) NOT NULL DEFAULT '' COMMENT '负责人',
+  `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '-1:逻辑删除,  0:关闭,  1:正常',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_alarm_name` (`alarm_name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='告警规则表';
+
+
+CREATE TABLE `broker` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
+  `cluster_id` bigint(128) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `broker_id` int(11) NOT NULL DEFAULT '-1' COMMENT 'BrokerID',
+  `host` varchar(128) NOT NULL DEFAULT '' COMMENT 'Broker主机名',
+  `port` int(32) NOT NULL DEFAULT '-1' COMMENT 'Broker端口',
+  `timestamp` bigint(128) NOT NULL DEFAULT '-1' COMMENT '启动时间',
+  `status` int(11) NOT NULL DEFAULT '0' COMMENT '状态0有效，-1无效',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_cluster_id_broker_id` (`cluster_id`,`broker_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Broker信息表';
+
+
+CREATE TABLE `broker_metrics` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增id',
+  `cluster_id` bigint(11) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `broker_id` int(11) NOT NULL DEFAULT '-1' COMMENT 'BrokerID',
+  `bytes_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒字节流入',
+  `bytes_out` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒字节流出',
+  `bytes_rejected` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒被拒绝字节数',
+  `messages_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒消息数流入',
+  `fail_fetch_request` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒消费失败数',
+  `fail_produce_request` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒失败生产数',
+  `fetch_consumer_request` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒消费请求数',
+  `produce_request` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒生产数',
+  `request_handler_idl_percent` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '请求处理器繁忙百分比',
+  `network_processor_idl_percent` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '网络处理器繁忙百分比',
+  `request_queue_size` bigint(20) NOT NULL DEFAULT '0' COMMENT '请求列表大小',
+  `response_queue_size` bigint(20) NOT NULL DEFAULT '0' COMMENT '响应列表大小',
+  `log_flush_time` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '刷日志时间',
+  `total_time_produce_mean` double(53,2) NOT NULL DEFAULT '0.00' COMMENT 'produce请求处理总时间-平均值',
+  `total_time_produce_99th` double(53,2) NOT NULL DEFAULT '0.00' COMMENT 'produce请求处理总时间-99分位',
+  `total_time_fetch_consumer_mean` double(53,2) NOT NULL DEFAULT '0.00' COMMENT 'fetch请求总时间-平均值',
+  `total_time_fetch_consumer_99th` double(53,2) NOT NULL DEFAULT '0.00' COMMENT 'fetch请求总时间-99分位',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  PRIMARY KEY (`id`),
+  KEY `idx_cluster_id_broker_id_gmt_create` (`cluster_id`,`broker_id`,`gmt_create`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='BrokerMetric信息表';
+
+
+CREATE TABLE `cluster` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '集群ID',
+  `cluster_name` varchar(128) NOT NULL DEFAULT '' COMMENT '集群名称',
+  `zookeeper` varchar(512) NOT NULL DEFAULT '' COMMENT 'ZK地址',
+  `bootstrap_servers` varchar(512) NOT NULL DEFAULT '' COMMENT 'Server地址',
+  `kafka_version` varchar(32) NOT NULL DEFAULT '' COMMENT 'Kafka版本',
+  `alarm_flag` int(4) NOT NULL DEFAULT '0' COMMENT '0:不开启告警, 1开启告警',
+  `security_protocol` varchar(512) NOT NULL DEFAULT '' COMMENT '安全协议',
+  `sasl_mechanism` varchar(512) NOT NULL DEFAULT '' COMMENT '安全机制',
+  `sasl_jaas_config` varchar(512) NOT NULL DEFAULT '' COMMENT 'Jaas配置',
+  `status` int(4) NOT NULL DEFAULT '0' COMMENT '删除标记, 0表示未删除, -1表示删除',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_cluster_name` (`cluster_name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Cluster表';
+
+
+CREATE TABLE `cluster_metrics` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增id',
+  `cluster_id` bigint(11) NOT NULL DEFAULT '0' COMMENT '集群ID',
+  `topic_num` int(11) NOT NULL DEFAULT '0' COMMENT 'Topic数',
+  `partition_num` int(11) NOT NULL DEFAULT '0' COMMENT '分区数',
+  `broker_num` int(11) NOT NULL DEFAULT '0' COMMENT 'Broker数',
+  `bytes_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒流入(B)',
+  `bytes_out` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒流出(B)',
+  `bytes_rejected` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒拒绝(B)',
+  `messages_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒消息数(条)',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  PRIMARY KEY (`id`),
+  KEY `idx_cluster_id_gmt_create` (`cluster_id`,`gmt_create`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='ClusterMetrics信息';
+
+
+CREATE TABLE `controller` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增id',
+  `cluster_id` bigint(20) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `broker_id` int(11) NOT NULL DEFAULT '-1' COMMENT 'BrokerId',
+  `host` varchar(256) NOT NULL DEFAULT '' COMMENT '主机名',
+  `timestamp` bigint(20) NOT NULL DEFAULT '-1' COMMENT 'Controller变更时间',
+  `version` int(11) NOT NULL DEFAULT '-1' COMMENT 'Controller格式版本',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_cluster_id_broker_id_timestamp` (`cluster_id`,`broker_id`,`timestamp`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Controller历史变更记录表';
+
+CREATE TABLE `migration_task` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增id',
+  `cluster_id` bigint(128) NOT NULL DEFAULT '0' COMMENT '集群ID',
+  `topic_name` varchar(256) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `reassignment_json` text COMMENT '任务参数',
+  `real_throttle` bigint(20) NOT NULL DEFAULT '0' COMMENT '实际限流值(B/s)',
+  `operator` varchar(128) NOT NULL DEFAULT '' COMMENT '操作人',
+  `description` varchar(256) NOT NULL DEFAULT '' COMMENT '备注说明',
+  `status` int(11) NOT NULL DEFAULT '0' COMMENT '任务状态',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '任务创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '任务修改时间',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Topic迁移信息';
+
+CREATE TABLE `operation_history` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
+  `cluster_id` bigint(128) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `topic_name` varchar(128) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `operator` varchar(128) NOT NULL DEFAULT '' COMMENT '操作人',
+  `operation` varchar(256) NOT NULL DEFAULT '' COMMENT '操作描述',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='操作记录表';
+
+
+CREATE TABLE `order_partition` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
+  `cluster_id` bigint(20) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `cluster_name` varchar(256) NOT NULL DEFAULT '' COMMENT '集群名称',
+  `topic_name` varchar(256) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `applicant` varchar(128) NOT NULL DEFAULT '' COMMENT '申请人',
+  `peak_bytes_in` bigint(20) NOT NULL DEFAULT '0' COMMENT '峰值流量',
+  `description` text COMMENT '备注信息',
+  `order_status` int(16) NOT NULL DEFAULT '0' COMMENT '工单状态',
+  `approver` varchar(128) NOT NULL DEFAULT '' COMMENT '审批人',
+  `opinion` varchar(256) NOT NULL DEFAULT '' COMMENT '审批意见',
+  `status` int(11) NOT NULL DEFAULT '0' COMMENT '状态，0标识有效，-1无效',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='分区申请工单';
+
+CREATE TABLE `order_topic` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID',
+  `cluster_id` bigint(20) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `cluster_name` varchar(256) NOT NULL DEFAULT '' COMMENT '集群名称',
+  `topic_name` varchar(256) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `retention_time` bigint(20) NOT NULL DEFAULT '-1' COMMENT '保留时间(ms)',
+  `partition_num` int(16) NOT NULL DEFAULT '-1' COMMENT '分区数',
+  `replica_num` int(16) NOT NULL DEFAULT '-1' COMMENT '副本数',
+  `regions` varchar(128) NOT NULL DEFAULT '' COMMENT 'RegionId列表',
+  `brokers` varchar(128) NOT NULL DEFAULT '' COMMENT 'Broker列表',
+  `peak_bytes_in` bigint(20) NOT NULL DEFAULT '0' COMMENT '峰值流入流量(KB)',
+  `applicant` varchar(128) NOT NULL DEFAULT '' COMMENT '申请人',
+  `principals` varchar(256) NOT NULL DEFAULT '' COMMENT '负责人',
+  `description` text COMMENT '备注信息',
+  `order_status` int(16) NOT NULL DEFAULT '0' COMMENT '工单状态',
+  `approver` varchar(128) NOT NULL DEFAULT '' COMMENT '审批人',
+  `opinion` varchar(256) NOT NULL DEFAULT '' COMMENT '审批意见',
+  `status` int(16) NOT NULL DEFAULT '0' COMMENT '状态，0标识有效，-1无效',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Topic申请工单';
+
+CREATE TABLE `region` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
+  `cluster_id` bigint(20) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `region_name` varchar(256) NOT NULL DEFAULT '' COMMENT 'Region名称',
+  `broker_list` varchar(256) NOT NULL DEFAULT '' COMMENT 'Broker列表',
+  `level` int(16) NOT NULL DEFAULT '0' COMMENT 'Region重要等级, 0级普通, 1极重要，2级极重要',
+  `operator` varchar(45) NOT NULL DEFAULT '' COMMENT '操作人',
+  `description` text COMMENT '备注说明',
+  `status` int(11) NOT NULL DEFAULT '0' COMMENT '状态，0正常，-1废弃，1容量已满',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_cluster_id_region_name` (`cluster_id`,`region_name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Region信息表';
+
+CREATE TABLE `topic` (
+  `id` bigint(128) unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID',
+  `cluster_id` bigint(128) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `topic_name` varchar(256) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `applicant` varchar(256) NOT NULL DEFAULT '' COMMENT '申请人',
+  `principals` varchar(256) NOT NULL DEFAULT '' COMMENT '负责人',
+  `description` text COMMENT '备注信息',
+  `status` int(16) NOT NULL DEFAULT '0' COMMENT '0标识使用中，-1标识已废弃',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_cluster_id_topic_name` (`cluster_id`,`topic_name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Topic信息表';
+
+
+CREATE TABLE `topic_favorite` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增Id',
+  `username` varchar(128) NOT NULL DEFAULT '' COMMENT '用户名',
+  `cluster_id` bigint(20) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `topic_name` varchar(512) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `status` int(16) NOT NULL DEFAULT '0' COMMENT '删除标记, 0表示未删除, -1表示删除',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `gmt_modify` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uniq_username_cluster_id_topic_name` (`username`,`cluster_id`,`topic_name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户收藏的Topic表';
+
+CREATE TABLE `topic_metrics` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增id',
+  `cluster_id` bigint(11) NOT NULL DEFAULT '-1' COMMENT '集群ID',
+  `topic_name` varchar(256) NOT NULL DEFAULT '' COMMENT 'Topic名称',
+  `messages_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒进入消息条数',
+  `bytes_in` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒字节流入',
+  `bytes_out` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒字节流出',
+  `bytes_rejected` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒拒绝字节数',
+  `total_produce_requests` double(53,2) NOT NULL DEFAULT '0.00' COMMENT '每秒请求数',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  PRIMARY KEY (`id`),
+  KEY `idx_cluster_id_topic_name_gmt_create` (`cluster_id`,`topic_name`,`gmt_create`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='TopicMetrics表';

docs/install_cn_guide.md

@@ -0,0 +1,63 @@
+
+---
+
+![kafka-manager-logo](./assets/images/common/logo_name.png)
+
+**一站式`Apache Kafka`集群指标监控与运维管控平台**
+
+--- 
+
+# 安装手册
+
+
+## 环境依赖
+
+- `Maven`(后端打包依赖)
+- `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 kafka-manager-opensource/console
+npm install
+npm run prod-build
+mv dist/* ../web/src/main/resources/templates
+
+# 后端工程包
+cd ..
+mvn install
+
+```
+
+---
+
+## 启动
+
+```
+# application.yml 是配置文件
+
+cp web/src/main/resources/application.yml web/target/
+cd web/target/
+nohup java -jar kafka-manager-web-1.0.0-SNAPSHOT.jar --spring.config.location=./application.yml > /dev/null 2>&1 &
+```
+
+## 使用
+
+本地启动的话，访问`http://localhost:8080`，输入帐号及密码进行登录。更多参考：[kafka-manager使用手册](./user_cn_guide.md)
+

docs/user_cn_guide.md

@@ -0,0 +1,166 @@
+
+---
+
+![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)