diff --git a/README.md b/README.md index 592844b3..49fb43d0 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,77 @@ -## Introduction +## 介绍 -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` 组合方案到夜莺。 -## Screenshot +- 内置丰富的Dashboard、好用实用的告警管理、自定义视图、故障自愈; +- Dashboard和告警策略支持一键导入,详细的指标分类和解释; +- 支持多 Prometheus 数据源管理,以一个集中的视图来管理所有的告警和dashboard; +- 支持 Prometheus、M3DB、VictoriaMetrics、Influxdb、TDEngine 等多种时序库作为存储方案; +- 原生支持 PromQL; +- 支持 Exporter 作为数据采集方案; +- 支持 Telegraf 作为监控数据采集方案; +- 支持对接 Grafana 作为补充可视化方案; -- alerts: -![mysql-alerts](doc/img/mysql-alerts.png) +#### 如果您在使用 Prometheus 过程中,有以下的一个或者多个需求场景,推荐您升级到夜莺: -- dashboard: +- Prometheus、Alertmanager、Grafana 等多个系统较为割裂,缺乏统一视图,无法开箱即用; +- 通过修改配置文件来管理 Prometheus、Alertmanager 的方式,学习曲线大,协同有难度; +- 数据量过大而无法扩展您的 Prometheus 集群; +- 生产环境运行多套 Prometheus 集群,面临管理和使用成本高的问题; -![redis-dashboard](doc/img/redis-dash.png) +#### 如果您在使用Zabbix,有以下的场景,推荐您升级到夜莺: -## Architecture +- 监控的数据量太大,希望有更好的扩展解决方案; +- 学习曲线高,多人多团队模式下,希望有更好的协同使用效率; +- 微服务和云原生架构下,监控数据的生命周期多变、监控数据维度基数高,Zabbix数据模型不易适配; -![n9e-architecture](doc/img/arch.png) -## Docs +#### 如果您在使用[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)。 -[https://n9e.github.io/](https://n9e.github.io/) +## 快速安装部署 +- [n9e.github.io/quickstart](https://n9e.github.io/quickstart/) + +## 详细文档 +- [n9e.github.io](https://n9e.github.io/) + +## 产品演示 +#### 您可以直接导入并生成 MySQL 相关的告警策略: + + +#### 您可以直接导入并生成主机相关的 dashboard: + + +#### 您也可以在夜莺中方便的查看所有活跃的告警以及历史告警: + + +## 系统架构 +#### 一个典型的 Nightingale 部署架构: + + +#### 使用 VictoriaMetrics 作为时序数据库的典型部署架构: + + + +## 联系我们和反馈问题 +- 我们推荐您优先使用[github issue](https://github.com/didi/nightingale/issues)作为首选问题反馈和需求提交的通道; +- 您可以加入我们的微信群组——[Nightingale 微信群组](https://s3-gz01.didistatic.com/n9e-pub/image/n9e-wx.png); +- 当然,推荐您关注夜莺监控公众号,及时获取相关产品动态 + + + + +## 参与到夜莺开源项目和社区 +我们欢迎您以各种方式参与到夜莺开源项目和开源社区中来,工作包括不限于: +- 反馈使用中遇到的问题和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) +- 参与我们的社区活动 => [Nightingale 微信群组](https://s3-gz01.didistatic.com/n9e-pub/image/n9e-wx.png) +- 提交代码,让夜莺监控更快、更稳、更好用 =>[github PR](https://github.com/didi/nightingale/pulls) ## TODO - - [x] deploy nightingale in docker - [x] export /metrics endpoint - [x] notify.py support feishu @@ -30,11 +80,5 @@ Nightingale is an enterprise-level cloud-native monitoring system, which can be - [x] support remote write api - [ ] support pushgateway api - -## Any questions? - -[Click me](https://s3-gz01.didistatic.com/n9e-pub/image/n9e-wx.png) - - -## Contributing -Any contributions are welcome. +## License +夜莺监控,采用[Apache License V2.0](https://github.com/didi/nightingale/blob/main/LICENSE)开源许可证。 \ No newline at end of file diff --git a/doc/img/n9e-node-dashboard.png b/doc/img/n9e-node-dashboard.png new file mode 100644 index 00000000..44622b11 Binary files /dev/null and b/doc/img/n9e-node-dashboard.png differ