From 4efdc4f169bc39711e33e32ee29648a5c78e3912 Mon Sep 17 00:00:00 2001 From: laiwei Date: Wed, 6 Jul 2022 16:06:13 +0800 Subject: [PATCH] update format --- README.md | 63 +++++++++++++++++++------------------ doc/community-governance.md | 26 +++++++-------- 2 files changed, 45 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 9f0f32b6..5f8d8e7e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ - + [English](./README_EN.md) | [中文](./README.md) -## 介绍 +Nightingale is an enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and management. -> Nightingale is an enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and management. -> ->夜莺是一款开源的云原生监控系统，采用 All-In-One 的设计，提供企业级的功能特性，开箱即用的产品体验。推荐升级您的 `Prometheus` + `AlertManager` + `Grafana` 组合方案到夜莺。夜莺监控具有以下特点： +夜莺是一款开源的云原生监控系统，采用 All-In-One 的设计，提供企业级的功能特性，开箱即用的产品体验。推荐升级您的 `Prometheus` + `AlertManager` + `Grafana` 组合方案到夜莺。 -* 开箱即用 ->支持 Docker、Helm Chart 等多种部署方式，内置多种监控大盘、快捷视图、告警规则模板，导入即可快速使用，活跃、专业的社区用户也在持续迭代和沉淀更多的最佳实践于产品中； +# 夜莺监控具有以下特点 -* 兼容并包 ->支持 [Categraf](https://github.com/flashcatcloud/categraf)、Telegraf、Grafana-agent 等多种采集器，支持 Prometheus、VictoriaMetrics、M3DB 等各种时序数据库，支持对接 Grafana，与云原生生态无缝集成； +##### 开箱即用 +支持 Docker、Helm Chart 等多种部署方式，内置多种监控大盘、快捷视图、告警规则模板，导入即可快速使用，活跃、专业的社区用户也在持续迭代和沉淀更多的最佳实践于产品中； -* 开放社区 ->托管于[中国计算机学会开源发展委员会](https://www.ccf.org.cn/kyfzwyh/)，有[快猫星云](https://flashcat.cloud)的持续投入，和数千名社区用户的积极参与，以及夜莺监控项目清晰明确的定位，都保证了夜莺开源社区健康、长久的发展； +##### 兼容并包 +支持 [Categraf](https://github.com/flashcatcloud/categraf)、Telegraf、Grafana-agent 等多种采集器，支持 Prometheus、VictoriaMetrics、M3DB 等各种时序数据库，支持对接 Grafana，与云原生生态无缝集成； -* 高性能 ->得益于夜莺的多数据源管理引擎，和夜莺引擎侧优秀的架构设计，借助于高性能时序库，可以满足数亿时间线的采集、存储、告警分析场景，节省大量成本； +##### 开放社区 +托管于[中国计算机学会开源发展委员会](https://www.ccf.org.cn/kyfzwyh/)，有[快猫星云](https://flashcat.cloud)的持续投入，和数千名社区用户的积极参与，以及夜莺监控项目清晰明确的定位，都保证了夜莺开源社区健康、长久的发展； -* 高可用 ->夜莺监控组件均可水平扩展，无单点，已在上千家企业部署落地，经受了严苛的生产实践检验。众多互联网头部公司，夜莺集群机器达百台，处理十亿级时间线，重度使用夜莺监控； +##### 高性能 +得益于夜莺的多数据源管理引擎，和夜莺引擎侧优秀的架构设计，借助于高性能时序库，可以满足数亿时间线的采集、存储、告警分析场景，节省大量成本； -* 灵活扩展 ->夜莺监控，可部署在1核1G的云主机，可在上百台机器部署集群，可运行在K8s中；也可将时序库、告警引擎等组件下沉到各机房、各region，兼顾边缘部署和中心化管理； +##### 高可用 +夜莺监控组件均可水平扩展，无单点，已在上千家企业部署落地，经受了严苛的生产实践检验。众多互联网头部公司，夜莺集群机器达百台，处理十亿级时间线，重度使用夜莺监控； + +##### 灵活扩展 +夜莺监控，可部署在1核1G的云主机，可在上百台机器部署集群，可运行在K8s中；也可将时序库、告警引擎等组件下沉到各机房、各region，兼顾边缘部署和中心化管理； #### 如果您在使用 Prometheus 过程中，有以下的一个或者多个需求场景，推荐您升级到夜莺： @@ -41,23 +41,23 @@ - 微服务和云原生架构下，监控数据的生命周期多变、监控数据维度基数高，Zabbix数据模型不易适配； #### 如果您在使用 [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) 作为首选的监控数据采集器： -> Categraf 是夜莺监控的默认采集器，采用开放插件机制和 all-in-one 的设计，同时支持 metric、log、trace、event 的采集。Categraf 不仅可以采集 CPU、内存、网络等系统层面的指标，也集成了众多开源组件的采集能力，支持K8s生态。Categraf 内置了对应的仪表盘和告警规则，开箱即用。 +- Categraf 是夜莺监控的默认采集器，采用开放插件机制和 all-in-one 的设计，同时支持 metric、log、trace、event 的采集。Categraf 不仅可以采集 CPU、内存、网络等系统层面的指标，也集成了众多开源组件的采集能力，支持K8s生态。Categraf 内置了对应的仪表盘和告警规则，开箱即用。 -## 资料链接 +# 资料链接 - [快速安装](https://mp.weixin.qq.com/s/iEC4pfL1TgjMDOWYh8H-FA) - [详细文档](https://n9e.github.io/) - [社区分享](https://n9e.github.io/docs/prologue/share/) -## 产品演示 +# 产品演示 -## 架构介绍 +# 架构介绍 @@ -74,28 +74,29 @@ Nightingale 可以接收各种采集器上报的监控数据（比如 [Categraf] 如果单机版本的 Prometheus 性能不够或容灾较差，我们推荐使用 [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics)，VictoriaMetrics 架构较为简单，性能优异，易于部署和运维，架构图如上。VictoriaMetrics 更详尽的文档，还请参考其[官网](https://victoriametrics.com/)。 -## 如何参与 +# 如何参与 -开源项目要更有生命力，离不开开放的治理架构和源源不断的开发者和用户共同参与，我们致力于建立开放、中立的开源治理架构，吸纳更多来自高校、企业等各方面对云原生监控感兴趣、有热情的计算机专业人士，打造专业、有活力的开发者社区。关于`夜莺开源项目和社区治理架构（草案）`，请查阅 [doc/community-governance.md)](./doc/community-governance.md)。 +开源项目要更有生命力，离不开开放的治理架构和源源不断的开发者和用户共同参与，我们致力于建立开放、中立的开源治理架构，吸纳更多来自高校、企业等各方面对云原生监控感兴趣、有热情的计算机专业人士，打造专业、有活力的开发者社区。关于**夜莺开源项目和社区治理架构（草案）**，请查阅 [doc/community-governance.md)](./doc/community-governance.md)。 **我们欢迎您以各种方式参与到夜莺开源项目和开源社区中来，工作包括不限于**： -- 补充和完善文档 => [n9e.github.io](https://n9e.github.io/) -- 分享您在使用夜莺监控过程中的最佳实践和经验心得 => [文章分享](https://n9e.github.io/docs/prologue/share/) -- 提交产品建议 =》 [github issue](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md) -- 提交代码，让夜莺监控更快、更稳、更好用 => [github pull request](https://github.com/didi/nightingale/pulls) +- 补充和完善文档 => [n9e.github.io](https://n9e.github.io/)； +- 分享您在使用夜莺监控过程中的最佳实践和经验心得 => [文章分享](https://n9e.github.io/docs/prologue/share/)； +- 提交产品建议 =》 [github issue](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md)； +- 提交代码，让夜莺监控更快、更稳、更好用 => [github pull request](https://github.com/didi/nightingale/pulls)； -`尊重、认可和记录每一位贡献者的工作`是夜莺开源社区的第一指导原则，我们提倡`高效的提问`，这既是对开发者时间的尊重，也是对整个社区的知识沉淀做贡献： +**尊重、认可和记录每一位贡献者的工作**是夜莺开源社区的第一指导原则，我们提倡**高效的提问**，这既是对开发者时间的尊重，也是对整个社区知识沉淀的贡献： 1. 提问之前请先查阅 [FAQ](https://www.gitlink.org.cn/ccfos/nightingale/wiki/faq) ； 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)； 4. 最后，我们推荐你加入微信群，针对相关开放式问题，相互交流咨询 (请先加好友：[UlricGO](https://www.gitlink.org.cn/UlricQin/gist/tree/master/self.jpeg) 备注：夜莺加群+姓名+公司，交流群里会有开发者团队和专业、热心的群友回答问题)； -## 联系我们 +# 联系我们 - 推荐您关注夜莺监控公众号，及时获取相关产品和社区动态 + -## License +# License - [Apache License V2.0](https://github.com/didi/nightingale/blob/main/LICENSE) \ No newline at end of file diff --git a/doc/community-governance.md b/doc/community-governance.md index d2ffa3e8..33e8b33d 100644 --- a/doc/community-governance.md +++ b/doc/community-governance.md @@ -1,26 +1,26 @@ -# Nightingale 项目和社区治理架构(草案) +# 夜莺开源项目和社区治理架构(草案) -### 用户(User) +#### 用户(User) -> 欢迎任何个人、公司以及组织，使用 Nightingale，并积极的反馈 bug、提交功能需求、以及相互帮助，我们推荐使用 github issue 来跟踪 bug 和管理需求。 +>欢迎任何个人、公司以及组织，使用 Nightingale，并积极的反馈 bug、提交功能需求、以及相互帮助，我们推荐使用 github issue 来跟踪 bug 和管理需求。 -### 贡献者(Contributer) +#### 贡献者(Contributer) -> 欢迎每一位用户，包括但不限于以下列方式参与到 Nightingale 开源项目并做出贡献： -1. 在 [github issue](https://github.com/ccfos/nightingale/issues) 中积极参与讨论； -2. 提交代码补丁； -3. 修订、补充和完善文档； -4. 提交建议 / 批评； +>欢迎每一位用户，包括但不限于以下列方式参与到 Nightingale 开源项目并做出贡献： +>1. 在 [github issue](https://github.com/ccfos/nightingale/issues) 中积极参与讨论； +>2. 提交代码补丁； +>3. 修订、补充和完善文档； +>4. 提交建议 / 批评； -### 提交者(Committer) +#### 提交者(Committer) >Committer 是指拥有 Nightingale 代码仓库写操作权限的贡献者，而且他们也签署了 Nightingale 项目贡献者许可协议（CLA），他们拥有 ccf.org.cn 为后缀的邮箱地址。原则上 Committer 能够自主决策某个代码补丁是否可以合入到 Nightingale 代码仓库，但是项目管委会拥有最终的决策权。 -### 项目管委会成员(PMC Member) +#### 项目管委会成员(PMC Member) > 项目管委会成员，从贡献者或者 Committer 中选举产生，他们拥有 Nightingale 代码仓库的写操作权限，拥有 ccf.org.cn 为后缀的邮箱地址，拥有 Nightingale 社区相关事务的投票权、以及提名Committer 候选人的权利。 项目管委会作为一个实体，为整个项目的发展全权负责。 -### 项目管委会主席(PMC Chair) +#### 项目管委会主席(PMC Chair) > 项目管委会主席采用任命制，由 [CCF ODC](https://www.ccf.org.cn/kyfzwyh/) 从项目管委会成员中任命产生。项目管委会作为一个统一的实体，来管理和领导 Nightingale 项目。管委会主席是 CCF ODC 和项目管委会之间的沟通桥梁，履行特定的项目管理职责。 @@ -44,7 +44,7 @@ >尊重、认可和记录每一位贡献者的工作； # 关于提问的原则 -按照`尊重、认可、记录每一位贡献者的工作`原则，我们提倡`高效的提问`，这既是对开发者时间的尊重，也是对整个社区的知识沉淀做贡献： +按照**尊重、认可、记录每一位贡献者的工作**原则，我们提倡**高效的提问**，这既是对开发者时间的尊重，也是对整个社区的知识沉淀的贡献： 1. 提问之前请先查阅 [FAQ](https://www.gitlink.org.cn/ccfos/nightingale/wiki/faq) ； 2. 提问之前请先搜索 [github issue](https://github.com/ccfos/nightingale/issues)；