UPDATE README
This commit is contained in:
parent
d2ef68daac
commit
118060cf77
49
README.md
49
README.md
|
@ -35,46 +35,51 @@
|
|||
#### 如果您在使用[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)。
|
||||
|
||||
## 快速安装部署
|
||||
- [n9e.github.io/quickstart](https://n9e.github.io/docs/install/compose/)
|
||||
## 资料链接
|
||||
|
||||
## 详细文档
|
||||
- [n9e.github.io](https://n9e.github.io/)
|
||||
- [快速安装](https://n9e.github.io/docs/install/compose/)
|
||||
- [详细文档](https://n9e.github.io/)
|
||||
- [网友分享](https://n9e.github.io/docs/prologue/share/)
|
||||
- [常见问题](https://www.gitlink.org.cn/ccfos/nightingale/wiki)
|
||||
- [提问](https://github.com/didi/nightingale/issues)
|
||||
|
||||
## 产品演示
|
||||
|
||||
<img src="doc/img/intro.gif" width="680">
|
||||
|
||||
## 系统架构
|
||||
## 架构介绍
|
||||
|
||||
<img src="doc/img/arch-product.png" width="680">
|
||||
|
||||
Nightingale 可以接收各种采集器上报的监控数据,转存到时序库(可以支持Prometheus、M3DB、VictoriaMetrics、Thanos等),并提供告警规则、屏蔽规则、订阅规则的配置能力,提供监控数据的查看能力,提供告警自愈机制(告警触发之后自动回调某个webhook地址或者执行某个脚本),提供历史告警事件的存储管理、分组查看的能力。
|
||||
|
||||
|
||||
#### 一个典型的 Nightingale 部署架构:
|
||||
<img src="doc/img/arch-system.png" width="680">
|
||||
|
||||
#### 使用 VictoriaMetrics 作为时序数据库的典型部署架构:
|
||||
夜莺 v5 版本的设计非常简单,核心是 server 和 webapi 两个模块,webapi 无状态,放到中心端,承接前端请求,将用户配置写入数据库;server 是告警引擎和数据转发模块,一般随着时序库走,一个时序库就对应一套 server,每套 server 可以只用一个实例,也可以多个实例组成集群,server 可以接收 Categraf、Telegraf、Grafana-Agent、Datadog-Agent、Falcon-Plugins 上报的数据,写入后端时序库,周期性从数据库同步告警规则,然后查询时序库做告警判断。每套 server 依赖一个 redis。
|
||||
|
||||
|
||||
<img src="doc/img/install-vm.png" width="680">
|
||||
|
||||
|
||||
## FAQ
|
||||
|
||||
[https://github.com/ccfos/nightingale/wiki/faq](https://github.com/ccfos/nightingale/wiki/faq)
|
||||
|
||||
## 联系我们和反馈问题
|
||||
|
||||
- 我们推荐您优先使用[github issue](https://github.com/didi/nightingale/issues)作为首选问题反馈和需求提交的通道
|
||||
- 加入微信群组,请先添加微信:borgmon 备注:夜莺加群
|
||||
- 当然,推荐您关注夜莺监控公众号,及时获取相关产品动态,了解答疑方式
|
||||
|
||||
<img src="doc/img/wx.jpg" width="180">
|
||||
有些朋友可能会觉得单机版本的 Prometheus 性能不够或容灾较差,想要集群版本的时序库,我们推荐使用 VictoriaMetrics,VictoriaMetrics 架构较为简单,易于部署和运维,架构图如上,当然,VictoriaMetrics 更详尽的文档,还请参考其官网。
|
||||
|
||||
|
||||
## 参与到夜莺开源项目和社区
|
||||
## 如何参与
|
||||
|
||||
我们欢迎您以各种方式参与到夜莺开源项目和开源社区中来,工作包括不限于:
|
||||
|
||||
- 反馈使用中遇到的问题和Bug => [github issue](https://github.com/didi/nightingale/issues)
|
||||
- 补充和完善文档 => [n9e.github.io](https://n9e.github.io/)
|
||||
- 分享您在使用夜莺监控过程中的最佳实践和经验心得 => [夜莺User Story](https://github.com/didi/nightingale/issues/897) | [经验分享文章链接](https://n9e.github.io/docs/prologue/share/)
|
||||
- 提交代码,让夜莺监控更快、更稳、更好用 =>[github PR](https://github.com/didi/nightingale/pulls)
|
||||
- 分享您在使用夜莺监控过程中的最佳实践和经验心得 => [文章分享](https://n9e.github.io/docs/prologue/share/)
|
||||
- 提交代码,让夜莺监控更快、更稳、更好用 => [github pull request](https://github.com/didi/nightingale/pulls)
|
||||
|
||||
|
||||
## 联系我们
|
||||
|
||||
- 加入微信群组,请先添加微信:borgmon 备注:夜莺加群
|
||||
- 推荐您关注夜莺监控公众号,及时获取相关产品动态,了解答疑方式
|
||||
|
||||
<img src="doc/img/wx.jpg" width="180">
|
||||
|
||||
|
||||
## License
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 127 KiB |
Loading…
Reference in New Issue