diff --git a/README.md b/README.md index 35a06dad..a6e443a6 100644 --- a/README.md +++ b/README.md @@ -49,14 +49,14 @@ #### 您也可以在夜莺中方便的查看所有活跃的告警以及历史告警: - + ## 系统架构 #### 一个典型的 Nightingale 部署架构: - + #### 使用 VictoriaMetrics 作为时序数据库的典型部署架构: - + ## FAQ @@ -69,7 +69,7 @@ - 加入微信群组,请先添加微信:borgmon 备注:夜莺加群 - 当然,推荐您关注夜莺监控公众号,及时获取相关产品动态,了解答疑方式 - + ## 参与到夜莺开源项目和社区 diff --git a/README_EN.md b/README_EN.md index 638cbfb1..014bee01 100644 --- a/README_EN.md +++ b/README_EN.md @@ -45,20 +45,20 @@ Nightingale is an cloud-native monitoring system by All-In-On design, support en #### You can also easily view all active alerts and historical alerts in Nightingale: - + ## System Architecture #### A typical Nightingale deployment architecture: - + #### Typical deployment architecture using VictoriaMetrics as storage: - + ## Contact us and feedback questions - We recommend that you use [github issue](https://github.com/didi/nightingale/issues) as the preferred channel for issue feedback and requirement submission; - You can join our WeChat group - [Nightingale WeChat Group](https://s3-gz01.didistatic.com/n9e-pub/image/n9e-wx.png); - + ## Contributing @@ -69,14 +69,6 @@ We welcome your participation in the Nightingale open source project and open so - Join our community events => [Nightingale wechat group](https://s3-gz01.didistatic.com/n9e-pub/image/n9e-wx.png) - Submit code to make Nightingale better =>[github PR](https://github.com/didi/nightingale/pulls) -## TODO -- [x] deploy nightingale in docker -- [x] export /metrics endpoint -- [x] notify.py support feishu -- [ ] notify.py support sms -- [ ] notify.py support voice -- [x] support remote write api -- [ ] support pushgateway api ## License Nightingale with [Apache License V2.0](https://github.com/didi/nightingale/blob/main/LICENSE) open source license. diff --git a/doc/img/alert-events.png b/doc/img/alert-events.png new file mode 100644 index 00000000..aff84296 Binary files /dev/null and b/doc/img/alert-events.png differ diff --git a/doc/img/arch-system.png b/doc/img/arch-system.png new file mode 100644 index 00000000..5c765831 Binary files /dev/null and b/doc/img/arch-system.png differ diff --git a/doc/img/vm-cluster-arch.png b/doc/img/vm-cluster-arch.png new file mode 100644 index 00000000..93e41792 Binary files /dev/null and b/doc/img/vm-cluster-arch.png differ diff --git a/doc/img/wx.jpg b/doc/img/wx.jpg new file mode 100644 index 00000000..5ad2e2d8 Binary files /dev/null and b/doc/img/wx.jpg differ