diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 959a0795..651a9d95 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,12 +9,17 @@ assignees: '' - [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。 + 你是否希望来认领这个Bug。 + + 「 Y / N 」 + ### 环境信息 * KnowStreaming version : xxx * Operating System version : xxx * Java version : xxx + ### 重现该问题的步骤 1. xxx diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 30e38e30..3bedae4a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: true contact_links: + - name: 讨论问题 + url: https://github.com/didi/KnowStreaming/discussions/new + about: 发起问题、讨论 等等 - name: KnowStreaming官网 url: https://knowstreaming.com/ about: KnowStreaming website diff --git a/.github/ISSUE_TEMPLATE/detail_optimizing.md b/.github/ISSUE_TEMPLATE/detail_optimizing.md index a531ac8a..bbf168f1 100644 --- a/.github/ISSUE_TEMPLATE/detail_optimizing.md +++ b/.github/ISSUE_TEMPLATE/detail_optimizing.md @@ -9,6 +9,10 @@ assignees: '' - [ ] 我已经在 [issues](https://github.com/didi/KnowStreaming/issues) 搜索过相关问题了,并没有重复的。 + 你是否希望来认领这个优化建议。 + + 「 Y / N 」 + ### 环境信息 * KnowStreaming version : xxx diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md deleted file mode 100644 index bf2b8359..00000000 --- a/.github/ISSUE_TEMPLATE/discussion.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: 讨论/discussion -about: 开启一个关于KnowStreaming的讨论 -title: '' -labels: discussion -assignees: '' - ---- - -## 讨论主题 - -... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index fe7e88fb..7bfc5d9b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,7 +8,12 @@ assignees: '' --- - [ ] 我在 [issues](https://github.com/didi/KnowStreaming/issues) 中并未搜索到与此相关的功能需求。 -- [ ] 我在 [release notes] (https://github.com/didi/KnowStreaming/releases)已经发布的版本中并没有搜到相关功能. +- [ ] 我在 [release note](https://github.com/didi/KnowStreaming/releases) 已经发布的版本中并没有搜到相关功能. + +你是否希望来认领这个Feature。 + +「 Y / N 」 + ## 这里描述需求 diff --git a/README.md b/README.md index 5b630fb0..9cc19762 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,14 @@ ## `Know Streaming` 简介 -`Know Streaming`是一套云原生的Kafka管控平台，脱胎于众多互联网内部多年的Kafka运营实践经验，专注于Kafka运维管控、监控告警、资源治理、多活容灾等核心场景。在用户体验、监控、运维管控上进行了平台化、可视化、智能化的建设，提供一系列特色的功能，极大地方便了用户和运维人员的日常使用，让普通运维人员都能成为Kafka专家。整体具有以下特点： +`Know Streaming`是一套云原生的Kafka管控平台，脱胎于众多互联网内部多年的Kafka运营实践经验，专注于Kafka运维管控、监控告警、资源治理、多活容灾等核心场景。在用户体验、监控、运维管控上进行了平台化、可视化、智能化的建设，提供一系列特色的功能，极大地方便了用户和运维人员的日常使用，让普通运维人员都能成为Kafka专家。 + +我们现在正在收集 Know Streaming 用户信息，以帮助我们进一步改进 Know Streaming。 +请在 [issue#663](https://github.com/didi/KnowStreaming/issues/663) 上提供您的使用信息来支持我们：[谁在使用 Know Streaming](https://github.com/didi/KnowStreaming/issues/663) + + + +整体具有以下特点： - 👀  **零侵入、全覆盖** - 无需侵入改造 `Apache Kafka` ，一键便能纳管 `0.10.x` ~ `3.x.x` 众多版本的Kafka，包括 `ZK` 或 `Raft` 运行模式的版本，同时在兼容架构上具备良好的扩展性，帮助您提升集群管理水平； @@ -99,7 +106,11 @@ ## 成为社区贡献者 -点击 [这里](CONTRIBUTING.md)，了解如何成为 Know Streaming 的贡献者 +1. [贡献源码](https://doc.knowstreaming.com/product/10-contribution) 了解如何成为 Know Streaming 的贡献者 +2. [具体贡献流程](https://doc.knowstreaming.com/product/10-contribution#102-贡献流程) +3. [开源激励计划](https://doc.knowstreaming.com/product/10-contribution#105-开源激励计划) +4. [贡献者名单](https://doc.knowstreaming.com/product/10-contribution#106-贡献者名单) + 获取KnowStreaming开源社区证书。 diff --git a/docs/contributer_guide/开发者名单.md b/docs/contributer_guide/开发者名单.md index ea147bdc..3f2c708d 100644 --- a/docs/contributer_guide/开发者名单.md +++ b/docs/contributer_guide/开发者名单.md @@ -2,45 +2,5 @@ 开源贡献者证书发放名单(定期更新) -贡献者名单请看：[贡献者名单]() - - - -|姓名|Github|角色|发放日期| -|--|--|--|--| -|张亮 | [@zhangliangboy](https://github.com/zhangliangboy)||| -|赵情融 | [@zqrferrari](https://github.com/zqrferrari)||| -|谢鹏|[@PenceXie](https://github.com/PenceXie)||| -|孙超|[@lucasun](https://github.com/lucasun)||| -|许喆 | [@potaaaaaato](https://github.com/potaaaaaato)||| -|石臻臻 | [@shirenchuang](https://github.com/shirenchuang)||| -|郭宇航|[@GraceWalk](https://github.com/GraceWalk)||| -|曾巧|[@ZQKC](https://github.com/ZQKC)||| -|赵寅锐|[@ZHAOYINRUI](https://github.com/ZHAOYINRUI)||| -|王东方|[@wangdongfang-aden](https://github.com/wangdongfang-aden)||| -|haoqi123|[@[haoqi123]](https://github.com/haoqi123)||| -|17hao|[@17hao](https://github.com/17hao)||| -|Huyueeer|[@Huyueeer](https://github.com/Huyueeer)||| -|杨光|[@yaangvipguang](https://github.com/yangvipguang)| -|王亚聪|[@wangyacongi](https://github.com/wangyacongi)| -|王耀波|[@WYAOBO](https://github.com/WYAOBO) -| Super .Wein（星痕）| [@superspeedone](https://github.com/superspeedone)||| -| Yang Jing| [@yangbajing](https://github.com/yangbajing)||| -| 刘新元 Liu XinYuan| [@Liu-XinYuan](https://github.com/Liu-XinYuan)||| -|Joker | [@LiubeyJokerQueue](https://github.com/JokerQueue)||| -|Eason Lau | [@Liubey](https://github.com/Liubey)||| -| hailanxin| [@hailanxin](https://github.com/hailanxin)||| -| Qi Zhang| [@zzzhangqi](https://github.com/zzzhangqi)||| -|Hongten | [@Hongten](https://github.com/Hongten)||| -|fengxsong | [@fengxsong](https://github.com/fengxsong)||| -|f1558 | [@f1558](https://github.com/f1558)||| -| 谢晓东| [@Strangevy](https://github.com/Strangevy)||| -| ZhaoXinlong| [@ZhaoXinlong](https://github.com/ZhaoXinlong)||| -|xuehaipeng | [@xuehaipeng](https://github.com/xuehaipeng)||| -|孔令续 | [@mrazkong](https://github.com/mrazkong)||| -|徐正熙 | [@hyper-xx)](https://github.com/hyper-xx)||| -|pierre xiong | [@pierre94](https://github.com/pierre94)||| - - - +贡献者名单请看：[贡献者名单](https://doc.knowstreaming.com/product/10-contribution#106-贡献者名单) diff --git a/docs/contributer_guide/贡献流程.md b/docs/contributer_guide/贡献流程.md index b6ec2a9a..42679379 100644 --- a/docs/contributer_guide/贡献流程.md +++ b/docs/contributer_guide/贡献流程.md @@ -1,121 +1,6 @@ -### 贡献流程 - -[贡献源码细则](../CONTRIBUTING.md) - -#### 1. fork didi/KnowStreaming项目到您的github库 - -找到你要Fork的项目,例如 [KnowStreaming](https://github.com/didi/KnowStreaming) ,点击Fork按钮。 - -![在这里插入图片描述](https://img-blog.csdnimg.cn/ac7bfef9ccde49d587c30e702a615ef5.png) - - -#### 2. 克隆或下载您fork的Nacos代码仓库到您本地 - -```sh - -git clone { your fork knowstreaming repo address } - -cd KnowStreaming - -``` - -#### 3. 添加 didi/KnowStreaming仓库为upstream仓库 - - -```sh - -### 添加源仓库 -git remote add upstream https://github.com/didi/KnowStreaming - -### 查看是否添加成功 -git remote -v - - origin ${your fork KnowStreaming repo address} (fetch) - origin ${your fork KnowStreaming repo address} (push) - upstream https://github.com/didi/KnowStreaming(fetch) - upstream https://github.com/didi/KnowStreaming (push) - -### 获取源仓库的基本信息 -git fetch origin -git fetch upstream - -``` -上面是将didi/KnowStreaming添加为远程仓库, 当前就会有2个远程仓库 - -1. origin ： 你Fork出来的分叉仓库 -2. upstream ： 源仓库 - -git fetch 获取远程仓库的基本信息, 比如 **源仓库**的所有分支就获取到了 - - -#### 4. 同步源仓库开发分支到本地分叉仓库中 - -一般开源项目都会有一个给贡献者提交代码的分支，例如 KnowStreaming的分支是 `dev`； - - -首先我们要将 **源仓库**的开发分支(`dev`) 拉取到本地仓库中 -```sh - -git checkout -b dev upstream/dev -``` -**或者IDEA的形式创建** - -![在这里插入图片描述](https://img-blog.csdnimg.cn/c95f2601a9af41889a5fc20b2a9724a5.png) - -#### 5. 在本地新建的开发分支上进行修改 - -首先请保证您阅读并正确设置KnowStreaming code style, 相关内容请阅读[KnowStreaming 代码规约 ]()。 - -修改时请保证该分支上的修改仅和issue相关，并尽量细化，做到 - -一个分支只修改一件事，一个PR只修改一件事。 - -同时，您的提交记录请尽量描述清楚，主要以谓 + 宾进行描述，如：Fix xxx problem/bug。少量简单的提交可以使用For xxx来描述，如：For codestyle。 如果该提交和某个ISSUE相关，可以添加ISSUE号作为前缀，如：For #10000, Fix xxx problem/bug。 - - -#### 6. Rebase 基础分支和开发分支 - -您修改的时候，可能别人的修改已经提交并被合并，此时可能会有冲突，这里请使用rebase命令进行合并解决，主要有2个好处： - -1. 您的提交记录将会非常优雅，不会出现Merge xxxx branch 等字样 -2. rebase后您分支的提交日志也是一条单链，基本不会出现各种分支交错的情况，回查时更轻松 - -```sh -git fetch upstream - -git rebase -i upstream/dev - -``` -**或者在IDEA的操作如下** - -![在这里插入图片描述](https://img-blog.csdnimg.cn/d75addcfa9564d3d9e1d226a2f7f4d64.png) -选择 源仓库的开发分支 -![在这里插入图片描述](https://img-blog.csdnimg.cn/4e85714df13b44bcb10f1e655450cb72.png) - -推荐使用IDEA的方式, 有冲突的时候更容易解决冲突问题。 - -#### 7. 将您开发完成rebase后的分支，上传到您fork的仓库 - -```sh -git push origin dev -``` - -#### 8. 按照PR模板中的清单创建Pull Request - - - -![在这里插入图片描述](https://img-blog.csdnimg.cn/1dab060aed314666970e3910e05f2205.png) - -选择自己的分支合并到模板分支。 - - -#### 9. 等待合并代码 - -提交了PR之后，需要等待PMC、Commiter 来Review代码，如果有问题需要配合修改重新提交。 - -如果没有问题会直接合并到开发分支`dev`中。 - -注： 如果长时间没有review, 则可以多催促社区来Review代码！ +
+
+请点击：[贡献流程](https://doc.knowstreaming.com/product/10-contribution#102-贡献流程) \ No newline at end of file diff --git a/docs/user_guide/faq.md b/docs/user_guide/faq.md index 98dfbf83..a91cdf79 100644 --- a/docs/user_guide/faq.md +++ b/docs/user_guide/faq.md @@ -37,7 +37,7 @@ ## 8.4、`Jmx`连接失败如何解决？ -- 参看 [Jmx 连接配置&问题解决](./9-attachment#jmx-连接失败问题解决) 说明。 +- 参看 [Jmx 连接配置&问题解决](https://doc.knowstreaming.com/product/9-attachment#91jmx-%E8%BF%9E%E6%8E%A5%E5%A4%B1%E8%B4%A5%E9%97%AE%E9%A2%98%E8%A7%A3%E5%86%B3) 说明。   diff --git a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/MonitorCmdData.java b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/MonitorCmdData.java index 7ea1339b..2fb3c9da 100644 --- a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/MonitorCmdData.java +++ b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/MonitorCmdData.java @@ -22,7 +22,7 @@ import lombok.Data; @Data public class MonitorCmdData extends BaseFourLetterWordCmdData { private String zkVersion; - private Long zkAvgLatency; + private Float zkAvgLatency; private Long zkMaxLatency; private Long zkMinLatency; private Long zkPacketsReceived; diff --git a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/ServerCmdData.java b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/ServerCmdData.java index 38bd2cf9..883231d6 100644 --- a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/ServerCmdData.java +++ b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/ServerCmdData.java @@ -17,7 +17,7 @@ import lombok.Data; @Data public class ServerCmdData extends BaseFourLetterWordCmdData { private String zkVersion; - private Long zkAvgLatency; + private Float zkAvgLatency; private Long zkMaxLatency; private Long zkMinLatency; private Long zkPacketsReceived; diff --git a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/parser/MonitorCmdDataParser.java b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/parser/MonitorCmdDataParser.java index a33f4da3..55921c12 100644 --- a/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/parser/MonitorCmdDataParser.java +++ b/km-common/src/main/java/com/xiaojukeji/know/streaming/km/common/bean/entity/zookeeper/fourletterword/parser/MonitorCmdDataParser.java @@ -57,7 +57,7 @@ public class MonitorCmdDataParser implements FourLetterWordDataParser