code refactor

Author: UlricQin

content/zh/docs/agent/categraf.md

@@ -1,9 +1,9 @@
 ---
 title: "Categraf"
-description: "使用 Categraf 作为采集器，采集指标、日志等数据，和夜莺项目丝滑对接"
+description: "使用 Categraf 作为夜莺监控的采集器，采集指标、日志等数据，和夜莺项目丝滑对接。Categraf 是一个开源的采集器，支持 Prometheus remote write 协议。通过 Prometheus remote write 协议，Categraf 可以将指标数据推送到夜莺监控。Categraf 还可以采集日志数据，并将其写入 Kafka。"
 lead: ""
 date: 2025-01-26T10:55:54+08:00
-lastmod: 2025-01-26T10:55:54+08:00
+lastmod: 2025-05-31T17:39:29.974+08:00
 draft: false
 images: []
 menu:
@@ -13,7 +13,7 @@ weight: 700
 toc: true
 ---
 
-[Categraf](https://github.com/flashcatcloud/categraf) 是一个可以采集指标和日志的代理。Categraf 使用 `prometheus remote write` 作为数据推送协议，因此可以将指标推送到夜莺。
+[Categraf](https://github.com/flashcatcloud/categraf) 是一个可以采集指标和日志的代理。Categraf 使用 `prometheus remote write` 作为指标数据推送协议，因此可以将指标推送到夜莺，日志的话，Categraf 是对接写给 Kafka。
 
 ## 配置
 
@@ -67,3 +67,7 @@ max_idle_conns_per_host = 100
 我们建议您使用 Categraf 采集机器的 CPU、内存等常规指标，因为 Categraf 和夜莺的对接最为丝滑。Categraf 会自动采集机器的元信息并且和夜莺对接提供告警自愈能力。
 
 至于 MySQL、Redis、Oracle、ElasticSearch、Kafka 等各类监控对象的数据采集，您也可以使用 Categraf，也可以使用您熟悉的其他采集器。
+
+## 边缘模式
+
+如果您采用了夜莺的边缘模式，即在某个边缘机房部署了 n9e-edge 组件，那边缘机房的 Categraf 就可以直接将数据推送到边缘机房的 n9e-edge 组件上，不需要推送到中心机房的夜莺。即：Categraf 配置文件中的 writer 和 heartbeat 的两个 url 都改为边缘机房的 n9e-edge 地址即可。

content/zh/docs/agent/datadog-agent.md

@@ -1,9 +1,9 @@
 ---
 title: "Datadog-Agent"
-description: "使用 Datadog-Agent 作为夜莺监控的采集器"
+description: "使用 Datadog-Agent 作为夜莺监控（Nightingale）的采集器，Datadog-Agent 是 Datadog 公司提供的一个开源的监控代理，支持多种数据采集方式。通过配置 Datadog-Agent，可以将指标数据推送到夜莺监控。"
 lead: ""
 date: 2025-01-26T10:55:54+08:00
-lastmod: 2025-01-26T10:55:54+08:00
+lastmod: 2025-05-31T17:49:58.236+08:00
 draft: false
 images: []
 menu:

content/zh/docs/agent/intro.md

@@ -1,9 +1,9 @@
 ---
 title: "前置说明"
-description: ""
+description: "夜莺监控（Nightingale）可以对接各类采集器，比如 Categraf、Telegraf、Alloy、Datadog-agent 等，这些采集器将监控数据推送给夜莺，夜莺转存到时序库。"
 lead: ""
 date: 2025-01-26T10:55:54+08:00
-lastmod: 2025-01-26T10:55:54+08:00
+lastmod: 2025-05-31T17:38:38.772+08:00
 draft: false
 images: []
 menu:
@@ -13,10 +13,10 @@ weight: 600
 toc: true
 ---
 
-夜莺作为一个告警引擎，不需要和采集器整合，直接对接各类数据源做查询告警即可。
+夜莺作为一个告警引擎，不需要和采集器整合，直接对接各类数据源，根据用户配置的告警规则，查询数据源的数据，然后做告警判定。
 
 即：如果你们已经采集了各类监控数据并存储到时序库中了，那就把时序库作为数据源配置到夜莺中，夜莺就可以直接查询时序库中的数据了。不需要用到本章提到的各类采集器。
 
 但是很多新用户并未构建自己的采集能力，因此我们提供了一些采集器的对接方案，方便用户快速上手。不过夜莺仍然不提供存储能力，这些采集器采集了数据推给夜莺，夜莺再把数据转存到时序库。
 
-夜莺的配置文件 `etc/config.toml` 中有个 `[[Pushgw.Writers]]` 的部分，就是用来配置时序库的地址的。夜莺收到数据后会把数据转发到这些地址。
+夜莺的配置文件 `etc/config.toml` 中有个 `[[Pushgw.Writers]]` 的部分，就是用来配置时序库的地址的。夜莺收到数据后会把数据转发到这些地址，走的是 Prometheus remote write 协议。

content/zh/docs/agent/telegraf.md

@@ -1,9 +1,9 @@
 ---
 title: "Telegraf"
-description: "使用 Telegraf 作为 Nightingale 的采集器"
+description: "使用 Telegraf 作为夜莺监控（Nightingale）的采集器，Telegraf 来自 InfluxData 公司，是一个用于收集、处理、聚合和写入指标的 agent。Telegraf 支持多种输出插件，我们可以使用 opentsdb 或 prometheusremotewrite 插件将指标发送到夜莺。"
 lead: ""
 date: 2022-05-12T13:26:54+01:00
-lastmod: 2025-01-26T10:55:54+08:00
+lastmod: 2025-05-31T17:49:24.577+08:00
 draft: false
 images: []
 menu:

content/zh/docs/install/configuration.md

@@ -317,9 +317,9 @@ QueueNumber = 0
 
 这部分配置默认是注释的，因为正常来讲，用户是不需要关注的，如果夜莺接收到太多数据，在内存里拥塞了，最终丢了指标，此时需要考虑调整这里的配置。
 
-夜莺会在内存里创建 QueueNumber 个队列，默认配置是 0，表示不指定具体数量，按照 CPU 核数来创建队列。每个队列的最大容量是 QueueMaxSize，默认是 1000000，表示每个队列最多可以存储 100 万条数据。每次从队列中取出数据的数量是 QueuePopSize，默认是 1000，表示每次从队列中取出 1000 条数据，作为一个批次写入到后端时序库。
+夜莺会在内存里创建 QueueNumber 个队列，收到监控数据之后，就会把数据放到这些队列中，QueueNumber 的默认配置是 0，表示不指定具体数量，按照 CPU 核数来创建队列。每个队列的最大容量是 QueueMaxSize，默认是 1000000，表示每个队列最多可以存储 100 万条数据。
 
-夜莺收到监控数据之后，就会把数据放到这些队列中，然后每个队列对应一个 goroutine，夜莺会从这些队列中取出数据，然后写入到后端时序库。这样做的好处是可以充分利用多核 CPU 的性能。所以，QueueNumber 的数量，本质就等于并发写入后端时序库的并发量。
+然后每个队列对应一个 goroutine，这个 goroutine 每次从队列中取出指标的数量是 QueuePopSize，默认是 1000，表示每次从队列中取出 1000 条数据，作为一个批次写入到后端时序库。这样做的好处是可以充分利用多核 CPU 的性能。所以，QueueNumber 的数量，本质就等于并发写入后端时序库的并发量。
 
 ### Pushgw.Writers
 

content/zh/docs/usage/_index.md

@@ -1,6 +1,5 @@
 ---
-title : "使用手册"
-description: "夜莺监控项目使用手册"
+title : "快速体验"
 lead: ""
 date: 2025-01-26T11:15:54+08:00
 lastmod: 2025-01-26T11:15:54+08:00

content/zh/docs/usage/datasource.md

@@ -1,7 +1,8 @@
 ---
 title: "配置数据源"
+description: "夜莺监控（Nightingale）支持对接各类数据源，包括 Prometheus、ElasticSearch 和 Grafana Loki 等。通过配置数据源，夜莺可以查询展示这些数据源中的监控数据，也可以对这些数据源中的数据进行告警。"
 date: 2025-01-26T11:15:54+08:00
-lastmod: 2025-01-26T11:15:54+08:00
+lastmod: 2025-05-31T17:50:57.530+08:00
 draft: false
 images: []
 menu:
@@ -11,12 +12,12 @@ weight: 1000
 toc: true
 ---
 
-夜莺支持对接各类数据源，目前支持的数据源有：
-
-- Prometheus，以及支持 Prometheus 协议的其他存储，比如 VictoriaMetrics、Thanos 等
-- ElasticSearch，以及支持 ElasticSearch 协议的其他存储，比如 OpenSearch 等
-- Grafana Loki
+夜莺支持对接各类数据源，前期支持的数据源，比如 Prometheus、VictoriaMetrics、ElasticSearch 等，既支持查询看图，也支持告警。后面随着项目发展，夜莺定位为一个告警引擎，数据源的查询看图功能会逐渐弱化，主要还是用于告警。所以新对接的数据源，比如 ClickHouse、MySQL、Postgres 等，都是只支持告警，不支持查询看图。
 
 在 `集成中心-数据源` 中添加数据源，选择对应的数据源类型，填写数据源的地址、用户名、密码等信息，点击保存即可。
 
-<img src="/img/usage/datasource/list_zh.png" alt="数据源"/>
+<img src="/img/usage/datasource/list_zh.png" alt="数据源"/>
+
+配置数据源时，除了要填写数据源的连接地址，另一个关键点是要选择关联的告警引擎，如果你的数据源是在边缘机房的，并且为边缘机房搭建了专属的 n9e-edge，那么就选择对应的 n9e-edge 作为关联的告警引擎。
+
+数据源配置中，表单各项基本都对应有 tooltip（就是各个 form 表单旁边的小问号 icon，鼠标放上去可以看到用法提示），这里就不再赘述了。