文档更新 & 问题修复

docs/dev_guide/免登录调用接口.md

@@ -1,43 +0,0 @@
-
-![Logo](../assets/KnowStreamingLogo.png)
-
-## 登录绕过
-
-### 背景
-
-现在除了开放出来的第三方接口，其他接口都需要走登录认证。
-
-但是第三方接口不多，开放出来的能力有限，但是登录的接口又需要登录，非常的麻烦。
-
-因此，新增了一个登录绕过的功能，为一些紧急临时的需求，提供一个调用不需要登录的能力。
-
-### 使用方式
-
-步骤一：接口调用时，在header中，增加如下信息：
-```shell
-# 表示开启登录绕过
-Trick-Login-Switch : on
-
-# 登录绕过的用户, 这里可以是admin, 或者是其他的, 但是必须在运维管控->平台管理->用户管理中设置了该用户。
-Trick-Login-User : admin
-```
-
- 
-
-步骤二：在运维管控->平台管理->平台配置上，设置允许了该用户以绕过的方式登录
-```shell
-# 设置的key，必须是这个
-SECURITY.TRICK_USERS
-
-# 设置的value，是json数组的格式，例如
-[ "admin", "logi"]
-```
-
- 
-
-步骤三：解释说明
-
-设置完成上面两步之后，就可以直接调用需要登录的接口了。
-
-但是还有一点需要注意，绕过的用户仅能调用他有权限的接口，比如一个普通用户，那么他就只能调用普通的接口，不能去调用运维人员的接口。
-

docs/dev_guide/多版本兼容方案.md

@@ -1,12 +1,13 @@
-## 3.2、Kafka 多版本兼容方案
+
+## 4.2、Kafka 多版本兼容方案
 
   当前 KnowStreaming 支持纳管多个版本的 kafka 集群，由于不同版本的 kafka 在指标采集、接口查询、行为操作上有些不一致，因此 KnowStreaming 需要一套机制来解决多 kafka 版本的纳管兼容性问题。
 
-### 3.2.1、整体思路
+### 4.2.1、整体思路
 
   由于需要纳管多个 kafka 版本，而且未来还可能会纳管非 kafka 官方的版本，kafka 的版本号会存在着多种情况，所以首先要明确一个核心思想：KnowStreaming 提供尽可能多的纳管能力，但是不提供无限的纳管能力，每一个版本的 KnowStreaming 只纳管其自身声明的 kafka 版本，后续随着 KnowStreaming 自身版本的迭代，会逐步支持更多 kafka 版本的纳管接入。
 
-### 3.2.2、构建版本兼容列表
+### 4.2.2、构建版本兼容列表
 
   每一个版本的 KnowStreaming 都声明一个自身支持纳管的 kafka 版本列表，并且对 kafka 的版本号进行归一化处理，后续所有 KnowStreaming 对不同 kafka 集群的操作都和这个集群对应的版本号严格相关。
 
@@ -14,7 +15,7 @@
 
   对于在集群接入过程中，如果希望接入当前 KnowStreaming 不支持的 kafka 版本的集群，KnowStreaming 建议在于的过程中选择相近的版本号接入。
 
-### 3.2.3、构建版本兼容性字典
+### 4.2.3、构建版本兼容性字典
 
   在构建了 KnowStreaming 支持的 kafka 版本列表的基础上，KnowStreaming 在实现过程中，还会声明自身支持的所有兼容性，构建兼容性字典。
 
@@ -31,7 +32,7 @@
 
 KS-KM 根据其需要纳管的 kafka 版本，按照上述三个维度构建了完善了兼容性字典。
 
-### 3.2.4、兼容性问题
+### 4.2.4、兼容性问题
 
   KS-KM 的每个版本针对需要纳管的 kafka 版本列表，事先分析各个版本的差异性和产品需求，同时 KS-KM 构建了一套专门处理兼容性的服务，来进行兼容性的注册、字典构建、处理器分发等操作，其中版本兼容性处理器是来具体处理不同 kafka 版本差异性的地方。
 

docs/dev_guide/指标说明.md

@@ -1,10 +1,10 @@
-## 2.3、指标说明
+## 3.3、指标说明
 
-  当前 KnowStreaming 支持针对 kafka 集群的多维度指标的采集和展示，同时也支持多个 kafka 版本的指标进行兼容，以下是 KnowStreaming 支持的指标说明。
+当前 KnowStreaming 支持针对 kafka 集群的多维度指标的采集和展示，同时也支持多个 kafka 版本的指标进行兼容，以下是 KnowStreaming 支持的指标说明。
 
-  现在对当前 KnowStreaming 支持的指标从指标名称、指标单位、指标说明、kafka 版本四个维度进行说明。
+现在对当前 KnowStreaming 支持的指标从指标名称、指标单位、指标说明、kafka 版本、企业/开源版指标 五个维度进行说明。
 
-### 2.3.1、Cluster 指标
+### 3.3.1、Cluster 指标
 
 | 指标名称                  | 指标单位 | 指标含义                             | kafka 版本       | 企业/开源版指标 |
 | ------------------------- | -------- | ------------------------------------ | ---------------- | --------------- |
@@ -73,7 +73,7 @@
 | LoadReBalanceNwOut        | 是/否    | BytesOut 是否均衡, 1：是；0：否      | 全部版本         | 企业版          |
 | LoadReBalanceDisk         | 是/否    | Disk 是否均衡, 1：是；0：否          | 全部版本         | 企业版          |
 
-### 2.3.2、Broker 指标
+### 3.3.2、Broker 指标
 
 | 指标名称                | 指标单位 | 指标含义                              | kafka 版本 | 企业/开源版指标 |
 | ----------------------- | -------- | ------------------------------------- | ---------- | --------------- |
@@ -105,7 +105,7 @@
 | LogSize                 | byte     | Broker 上的消息容量大小               | 全部版本   | 开源版          |
 | Alive                   | 是/否    | Broker 是否存活，1：存活；0：没有存活 | 全部版本   | 开源版          |
 
-### 2.3.3、Topic 指标
+### 3.3.3、Topic 指标
 
 | 指标名称              | 指标单位 | 指标含义                              | kafka 版本 | 企业/开源版指标 |
 | --------------------- | -------- | ------------------------------------- | ---------- | --------------- |
@@ -128,7 +128,7 @@
 | LogSize               | byte     | Topic 的大小                          | 全部版本   | 开源版          |
 | PartitionURP          | 个       | Topic 未同步的副本数                  | 全部版本   | 开源版          |
 
-### 2.3.4、Partition 指标
+### 3.3.4、Partition 指标
 
 | 指标名称       | 指标单位 | 指标含义                                  | kafka 版本 | 企业/开源版指标 |
 | -------------- | -------- | ----------------------------------------- | ---------- | --------------- |
@@ -139,7 +139,7 @@
 | BytesOut       | byte/s   | Partition 的每秒消息流出字节数            | 全部版本   | 开源版          |
 | LogSize        | byte     | Partition 的大小                          | 全部版本   | 开源版          |
 
-### 2.3.5、Group 指标
+### 3.3.5、Group 指标
 
 | 指标名称          | 指标单位 | 指标含义                   | kafka 版本 | 企业/开源版指标 |
 | ----------------- | -------- | -------------------------- | ---------- | --------------- |

docs/dev_guide/本地源码启动手册.md

@@ -20,6 +20,7 @@
 - MySQL 5.7
 - Idea
 - Elasticsearch 7.6
+- Git
 
 ### 6.1.3、环境初始化
 
@@ -63,7 +64,7 @@ es.client.address: 修改为实际ES地址
 
 **第三步：配置 IDEA**
 
-`Know streaming`的 Main 方法在：
+`Know Streaming`的 Main 方法在：
 
 ```java
 km-rest/src/main/java/com/xiaojukeji/know/streaming/km/rest/KnowStreaming.java
@@ -71,17 +72,19 @@ km-rest/src/main/java/com/xiaojukeji/know/streaming/km/rest/KnowStreaming.java
 
 IDEA 更多具体的配置如下图所示：
 
-![IDEA配置](./assets/startup_using_source_code/IDEA配置.jpg)
+<p align="center">
+<img src="./assets/startup_using_source_code/IDEA配置.jpg" width = "512" height = "318" div align=center />
+</p>
 
 **第四步：启动项目**
 
-最后就是启动项目，在本地 console 中输出了 `KnowStreaming-KM started` 则表示我们已经成功启动 `Know streaming` 了。
+最后就是启动项目，在本地 console 中输出了 `KnowStreaming-KM started` 则表示我们已经成功启动 `Know Streaming` 了。
 
 ### 6.1.5、本地访问
 
-`Know streaming` 启动之后，可以访问一些信息，包括：
+`Know Streaming` 启动之后，可以访问一些信息，包括：
 
 - 产品页面：http://localhost:8080 ，默认账号密码：`admin` / `admin2022_` 进行登录。
 - 接口地址：http://localhost:8080/swagger-ui.html 查看后端提供的相关接口。
 
-更多信息，详见：[KnowStreaming 官网](http://116.85.24.211/)
+更多信息，详见：[KnowStreaming 官网](https://knowstreaming.com/)

docs/dev_guide/登录系统对接.md

@@ -1,10 +1,6 @@
 
 ![Logo](../assets/KnowStreamingLogo.png)
 
-
-
-
-
 ## 登录系统对接
 
 ### 前言