From acb4b8e33e883f1d23e1c21f7c0842513bbde76d Mon Sep 17 00:00:00 2001 From: laiwei Date: Tue, 16 Aug 2022 14:20:57 +0800 Subject: [PATCH] improve community governance (#1115) --- README.md | 40 ++++++++++++++++++------------------- doc/active-contributors.md | 5 +++++ doc/committers.md | 5 +++++ doc/community-governance.md | 11 +++++----- doc/contributors.md | 5 +++++ doc/end-users.md | 5 +++++ doc/pmc.md | 7 +++++++ 7 files changed, 52 insertions(+), 26 deletions(-) create mode 100644 doc/contributors.md diff --git a/README.md b/README.md index 8ba17b43..df385459 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,20 @@ ## Highlighted Features - **开箱即用** - - 支持 Docker、Helm Chart 等多种部署方式，内置多种监控大盘、快捷视图、告警规则模板，导入即可快速使用，活跃、专业的社区用户也在持续迭代和沉淀更多的最佳实践于产品中； -- **兼容并包** - - 支持 [Categraf](https://github.com/flashcatcloud/categraf)、Telegraf、Grafana-agent 等多种采集器，支持 Prometheus、VictoriaMetrics、M3DB 等各种时序数据库，支持对接 Grafana，与云原生生态无缝集成； - - 集数据采集、可视化、监控告警、数据分析于一体，与云原生生态紧密集成，提供开箱即用的企业级监控分析和告警能力； -- **开放社区** - - 托管于[中国计算机学会开源发展委员会](https://www.ccf.org.cn/kyfzwyh/)，有[快猫星云](https://flashcat.cloud)的持续投入，和数千名社区用户的积极参与，以及夜莺监控项目清晰明确的定位，都保证了夜莺开源社区健康、长久的发展； -- **高性能** + - 支持 Docker、Helm Chart、云服务等多种部署方式，集数据采集、监控告警、可视化为一体，内置多种监控仪表盘、快捷视图、告警规则模板，导入即可快速使用，**大幅降低云原生监控系统的建设成本、学习成本、使用成本**； +- **专业告警** + - 可视化的告警配置和管理，支持丰富的告警规则，提供屏蔽规则、订阅规则的配置能力，支持告警多种送达渠道，支持告警自愈、告警事件管理等； +- **云原生** + - 以交钥匙的方式快速构建企业级的云原生监控体系，支持 [**Categraf**](https://github.com/flashcatcloud/categraf)、Telegraf、Grafana-agent 等多种采集器，支持 Prometheus、VictoriaMetrics、M3DB、ElasticSearch 等多种数据库，兼容支持导入 Grafana 仪表盘，**与云原生生态无缝集成**； +- **高性能，高可用** - 得益于夜莺的多数据源管理引擎，和夜莺引擎侧优秀的架构设计，借助于高性能时序库，可以满足数亿时间线的采集、存储、告警分析场景，节省大量成本； -- **高可用** - - 夜莺监控组件均可水平扩展，无单点，已在上千家企业部署落地，经受了严苛的生产实践检验。众多互联网头部公司，夜莺集群机器达百台，处理十亿级时间线，重度使用夜莺监控； -- **灵活扩展** - - 夜莺监控，可部署在1核1G的云主机，可在上百台机器部署集群，可运行在K8s中；也可将时序库、告警引擎等组件下沉到各机房、各region，兼顾边缘部署和中心化管理； + - 夜莺监控组件均可水平扩展，无单点，已在上千家企业部署落地，经受了严苛的生产实践检验。众多互联网头部公司，夜莺集群机器达百台，处理数亿级时间线，重度使用夜莺监控； +- **灵活扩展，中心化管理** + - 夜莺监控，可部署在 1 核 1G 的云主机，可在上百台机器集群化部署，可运行在 K8s 中；也可将时序库、告警引擎等组件下沉到各机房、各 Region，兼顾边缘部署和中心化统一管理，**解决数据割裂，缺乏统一视图的难题**； +- **开放社区** + - 托管于[中国计算机学会开源发展委员会](https://www.ccf.org.cn/kyfzwyh/)，有[**快猫星云**](https://flashcat.cloud)和众多公司的持续投入，和数千名社区用户的积极参与，以及夜莺监控项目清晰明确的定位，都保证了夜莺开源社区健康、长久的发展。活跃、专业的社区用户也在持续迭代和沉淀更多的最佳实践于产品中； -> 如果您在使用 Prometheus 过程中，有以下的一个或者多个需求场景，推荐您升级到夜莺： +> 如果您在使用 Prometheus 过程中，有以下的一个或者多个需求场景，推荐您无缝升级到夜莺： - Prometheus、Alertmanager、Grafana 等多个系统较为割裂，缺乏统一视图，无法开箱即用; - 通过修改配置文件来管理 Prometheus、Alertmanager 的方式，学习曲线大，协同有难度; @@ -50,7 +50,7 @@ > 如果您在使用 [Open-Falcon](https://github.com/open-falcon/falcon-plus)，我们更推荐您升级到夜莺： -- 关于 Open-Falcon 和夜莺的详细介绍，请参考阅读[《云原生监控的十个特点和趋势》](https://mp.weixin.qq.com/s?__biz=MzkzNjI5OTM5Nw==&mid=2247483738&idx=1&sn=e8bdbb974a2cd003c1abcc2b5405dd18&chksm=c2a19fb0f5d616a63185cd79277a79a6b80118ef2185890d0683d2bb20451bd9303c78d083c5#rd)。 +- 关于 Open-Falcon 和夜莺的详细介绍，请参考阅读：[云原生监控的十个特点和趋势](https://mp.weixin.qq.com/s?__biz=MzkzNjI5OTM5Nw==&mid=2247483738&idx=1&sn=e8bdbb974a2cd003c1abcc2b5405dd18&chksm=c2a19fb0f5d616a63185cd79277a79a6b80118ef2185890d0683d2bb20451bd9303c78d083c5#rd)。 > 我们推荐您使用 [Categraf](https://github.com/flashcatcloud/categraf) 作为首选的监控数据采集器： @@ -65,28 +65,28 @@ ## Screenshots - + ## Architecture - + 夜莺监控可以接收各种采集器上报的监控数据（比如 [Categraf](https://github.com/flashcatcloud/categraf)、telegraf、grafana-agent、Prometheus），并写入多种流行的时序数据库中（可以支持Prometheus、M3DB、VictoriaMetrics、Thanos、TDEngine等），提供告警规则、屏蔽规则、订阅规则的配置能力，提供监控数据的查看能力，提供告警自愈机制（告警触发之后自动回调某个webhook地址或者执行某个脚本），提供历史告警事件的存储管理、分组查看的能力。 - + 夜莺 v5 版本的设计非常简单，核心是 server 和 webapi 两个模块，webapi 无状态，放到中心端，承接前端请求，将用户配置写入数据库；server 是告警引擎和数据转发模块，一般随着时序库走，一个时序库就对应一套 server，每套 server 可以只用一个实例，也可以多个实例组成集群，server 可以接收 Categraf、Telegraf、Grafana-Agent、Datadog-Agent、Falcon-Plugins 上报的数据，写入后端时序库，周期性从数据库同步告警规则，然后查询时序库做告警判断。每套 server 依赖一个 redis。 - + -如果单机版本的 Prometheus 性能不够或容灾较差，我们推荐使用 [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics)，VictoriaMetrics 架构较为简单，性能优异，易于部署和运维，架构图如上。VictoriaMetrics 更详尽的文档，还请参考其[官网](https://victoriametrics.com/)。 +如果单机版本的时序数据库（比如 Prometheus） 性能有瓶颈或容灾较差，我们推荐使用 [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics)，VictoriaMetrics 架构较为简单，性能优异，易于部署和运维，架构图如上。VictoriaMetrics 更详尽的文档，还请参考其[官网](https://victoriametrics.com/)。 ## Community -开源项目要更有生命力，离不开开放的治理架构和源源不断的开发者和用户共同参与，我们致力于建立开放、中立的开源治理架构，吸纳更多来自企业、高校等各方面对云原生监控感兴趣、有热情的开发者，一起打造有活力的夜莺开源社区。关于《夜莺开源项目和社区治理架构（草案）》，请查阅 **[COMMUNITY GOVERNANCE](./doc/community-governance.md)**. +开源项目要更有生命力，离不开开放的治理架构和源源不断的开发者和用户共同参与，我们致力于建立开放、中立的开源治理架构，吸纳更多来自企业、高校等各方面对云原生监控感兴趣、有热情的开发者，一起打造有活力的夜莺开源社区。关于《夜莺开源项目和社区治理架构（草案）》，请查阅 [COMMUNITY GOVERNANCE](./doc/community-governance.md). **我们欢迎您以各种方式参与到夜莺开源项目和开源社区中来，工作包括不限于**： - 补充和完善文档 => [n9e.github.io](https://n9e.github.io/) @@ -119,4 +119,4 @@ ## Contact Us 推荐您关注夜莺监控公众号，及时获取相关产品和社区动态： - \ No newline at end of file + diff --git a/doc/active-contributors.md b/doc/active-contributors.md index e69de29b..04d0dcfd 100644 --- a/doc/active-contributors.md +++ b/doc/active-contributors.md @@ -0,0 +1,5 @@ +## Active Contributors + +- [xiaoziv](https://github.com/xiaoziv) +- [tanxiao1990](https://github.com/tanxiao1990) +- [bbaobelief](https://github.com/bbaobelief) diff --git a/doc/committers.md b/doc/committers.md index e69de29b..fd63ad03 100644 --- a/doc/committers.md +++ b/doc/committers.md @@ -0,0 +1,5 @@ +## Committers + +- [YeningQin](https://github.com/710leo) +- [FeiKong](https://github.com/kongfei605) +- [XiaqingDai](https://github.com/jsers) diff --git a/doc/community-governance.md b/doc/community-governance.md index 25918dd5..c024c530 100644 --- a/doc/community-governance.md +++ b/doc/community-governance.md @@ -34,13 +34,12 @@ Committer 承担以下一个或多个职责： Committer 记录并公示于 **[COMMITTERS](./committers.md)** 列表，并获得 **[CCF ODC](https://www.ccf.org.cn/kyfzwyh/)** 颁发的电子证书，以及享有夜莺开源社区的各种权益和福利。 -### 项目管委会成员(PMC Member) +### 项目管委会(PMC) -> 项目管委会成员，从 Contributor 或者 Committer 中选举产生，他们拥有 [CCFOS/NIGHTINGALE](https://github.com/ccfos/nightingale) 代码仓库的写操作权限，拥有 ccf.org.cn 为后缀的邮箱地址（待上线），拥有 Nightingale 社区相关事务的投票权、以及提名 Committer 候选人的权利。 项目管委会作为一个实体，为整个项目的发展全权负责。项目管委会成员记录并公示于 **[PMC](./pmc.md)** 列表。 +> 项目管委会作为一个实体，来管理和领导夜莺项目，为整个项目的发展全权负责。项目管委会相关内容记录并公示于文件[PMC](./pmc.md). -### 项目管委会主席(PMC Chair) - -> 项目管委会主席采用任命制，由 **[CCF ODC](https://www.ccf.org.cn/kyfzwyh/)** 从项目管委会成员中任命产生。项目管委会作为一个统一的实体，来管理和领导夜莺项目。管委会主席是 CCF ODC 和项目管委会之间的沟通桥梁，履行特定的项目管理职责。 +- 项目管委会成员(PMC Member)，从 Contributor 或者 Committer 中选举产生，他们拥有 [CCFOS/NIGHTINGALE](https://github.com/ccfos/nightingale) 代码仓库的写操作权限，拥有 ccf.org.cn 为后缀的邮箱地址（待上线），拥有 Nightingale 社区相关事务的投票权、以及提名 Committer 候选人的权利。 +- 项目管委会主席(PMC Chair)，由 **[CCF ODC](https://www.ccf.org.cn/kyfzwyh/)** 从项目管委会成员中任命产生。管委会主席是 CCF ODC 和项目管委会之间的沟通桥梁，履行特定的项目管理职责。 ## 沟通机制(Communication) 1. 我们推荐使用邮件列表来反馈建议（待发布）； @@ -71,4 +70,4 @@ Committer 记录并公示于 **[COMMITTERS](./committers.md)** 列表，并获 2. 提问之前请先搜索 [github issue](https://github.com/ccfos/nightingale/issues)； 3. 我们优先推荐通过提交 github issue 来提问，如果[有问题点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.yml) | [有需求建议点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md)； -最后，我们推荐你加入微信群，针对相关开放式问题，相互交流咨询 (请先加好友：[UlricGO](https://www.gitlink.org.cn/UlricQin/gist/tree/master/self.jpeg) 备注：夜莺加群+姓名+公司，交流群里会有开发者团队和专业、热心的群友回答问题)； \ No newline at end of file +最后，我们推荐你加入微信群，针对相关开放式问题，相互交流咨询 (请先加好友：[UlricGO](https://www.gitlink.org.cn/UlricQin/gist/tree/master/self.jpeg) 备注：夜莺加群+姓名+公司，交流群里会有开发者团队和专业、热心的群友回答问题)； diff --git a/doc/contributors.md b/doc/contributors.md new file mode 100644 index 00000000..2e68a627 --- /dev/null +++ b/doc/contributors.md @@ -0,0 +1,5 @@ +## Contributors + + + + diff --git a/doc/end-users.md b/doc/end-users.md index e69de29b..524621e1 100644 --- a/doc/end-users.md +++ b/doc/end-users.md @@ -0,0 +1,5 @@ +## End Users + +- [中移动](https://github.com/ccfos/nightingale/issues/897#issuecomment-1086573166) +- [inke](https://github.com/ccfos/nightingale/issues/897#issuecomment-1099840636) +- [方正证券](https://github.com/ccfos/nightingale/issues/897#issuecomment-1110492461) diff --git a/doc/pmc.md b/doc/pmc.md index e69de29b..db1e16c4 100644 --- a/doc/pmc.md +++ b/doc/pmc.md @@ -0,0 +1,7 @@ +## PMC Chair + +- [laiwei](https://github.com/laiwei) + +## PMC Member + +- [UlricQin](https://github.com/UlricQin)