This is an automated email from the ASF dual-hosted git repository.
albumenj pushed a commit to branch refactor/next
in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
The following commit(s) were added to refs/heads/refactor/next by this push:
new 9e08cb6beb 📝 observability meter doc write (#2113)
9e08cb6beb is described below
commit 9e08cb6beb9782564d791770f8e0afe1d511c693
Author: songxiaosheng <[email protected]>
AuthorDate: Thu Feb 9 16:16:29 2023 +0800
📝 observability meter doc write (#2113)
* :memo: observability meter doc write
* :memo: observability meter doc write
* :memo: observability meter doc write
* :memo: observability meter doc writen
---
.../zh-cn/overview/core-features/observability.md | 54 ++++++++++++++++-----
static/imgs/v3/advantages/grafana-dashboard-1.png | Bin 0 -> 103400 bytes
static/imgs/v3/advantages/grafana-dashboard-2.png | Bin 0 -> 213682 bytes
static/imgs/v3/advantages/metrics.png | Bin 0 -> 222069 bytes
static/imgs/v3/advantages/prometheus.png | Bin 0 -> 249921 bytes
5 files changed, 41 insertions(+), 13 deletions(-)
diff --git a/content/zh-cn/overview/core-features/observability.md
b/content/zh-cn/overview/core-features/observability.md
index 7c57005e51..a453e34a86 100644
--- a/content/zh-cn/overview/core-features/observability.md
+++ b/content/zh-cn/overview/core-features/observability.md
@@ -13,16 +13,13 @@ feature:
Dubbo 内部维护了多个纬度的可观测指标，并且支持多种方式的可视化监测。可观测性指标从总体上来说分为三个度量纬度：
* **Metrics。** Dubbo 统计了一系列的流量指标如
QPS、RT、成功请求数、失败请求数等，还包括一系列的内部组件状态如线程池数、服务健康状态等。
-
* **Tracing。** Dubbo 与业界主流的链路追踪工作做了适配，包括 Skywalking、Zipkin、Jaeger 都支持 Dubbo
服务的链路追踪。
-
* **Logging。** Dubbo 支持多种日志框架适配。以 Java 体系为例，支持包括
Slf4j、Log4j2、Log4j、Logback、Jcl 等，用户可以基于业务需要选择合适的框架；同时 Dubbo 还支持 Access Log
记录请求踪迹。
-
# 指标
## 指标模块简介
-Dubbo的指标模块帮助用户从外部观察正在运行的系统的内部服务状况 ，Dubbo参考
["四大黄金信号"](https://sre.google/sre-book/monitoring-distributed-systems/)
并结合实际企业应用场景从不同维度统计了丰富的关键指标，关注这些核心指标对于提供可用性的服务是至关重要的。
+Dubbo的指标模块帮助用户从外部观察正在运行的系统的内部服务状况 ，Dubbo参考
["四大黄金信号"](https://sre.google/sre-book/monitoring-distributed-systems/)、*RED方法*、*USE方法*等理论并结合实际企业应用场景从不同维度统计了丰富的关键指标，关注这些核心指标对于提供可用性的服务是至关重要的。
-Dubbo的关键指标包含：**延迟（Latency）**、**流量（Traffic）**、 **错误（Errors）** 和
**饱和度（Saturation）** 等内容 。同时，为了更好的监测服务运行状态，Dubbo
还提供了对核心组件状态的监控，如线程池数量、三大中心交互的指标数据等。
+Dubbo的关键指标包含：**延迟（Latency）**、**流量（Traffic）**、 **错误（Errors）** 和
**饱和度（Saturation）** 等内容 。同时，为了更好的监测服务运行状态，Dubbo
还提供了对核心组件状态的监控，如Dubbo应用信息、线程池信息、三大中心交互的指标数据等。
Dubbo目前推荐使用Prometheus来进行服务监控，Grafana来展示指标数据。接下来就通过案例来快速入门Dubbo的指标监控吧。
@@ -32,6 +29,8 @@ Dubbo目前推荐使用Prometheus来进行服务监控，Grafana来展示指标
- JDK 8 及以上
- Git
- Maven
+- Prometheus
+- Grafana
### 参考案例
Dubbo官方案例中提供了指标埋点的示例，可以访问如下地址获取案例源码：
@@ -59,19 +58,48 @@ Dubbo官方案例中提供了指标埋点的示例，可以访问如下地址获
</dubbo:metrics>
```
关于指标的配置可以参考配置项中的指标配置信息，在这里引入的配置中:
-- enable-jvm-metrics是对JVM指标的埋点， 如果不需要这些配置项可以将其删除或者设置为false，
-- aggregation配置是针对指标数据的聚合处理使监控指标更平滑，
-- prometheus-exporter配置为指标数据导出器，这里配置指标服务的端口号为20888，
+- **enable-jvm-metrics：** 是对JVM指标的埋点， 如果不需要这些配置项可以将其删除或者设置为false。
+- **aggregation：** 针对指标数据的聚合处理使监控指标更平滑。
+- **prometheus-exporter：** 指标数据导出器，这里配置指标服务的端口号为20888。
+
+配置完成后即可启动服务。
+
+### 指标获取
+
+前面的例子中提供了指标服务，接下来我们可以通过普罗米修斯来获取数据。
+普罗米修斯监控服务通过访问：[http://localhost:20888](http://localhost:20888) 即可拉取数据
+指标数据如下所示：
+
+
+普罗米修斯获取数据的配置参考如下：
+```yaml
+# A scrape configuration containing exactly one endpoint to scrape:
+# Here it's Prometheus itself.
+scrape_configs:
+ # The job name is added as a label `job=<job_name>` to any timeseries
scraped from this config.
+ - job_name: 'prometheus'
+
+ # metrics_path defaults to '/metrics'
+ # scheme defaults to 'http'.
+ - job_name: 'dubbo'
+ static_configs:
+ - targets: ['IP:20888']
+```
+当然在实际企业应用中这个服务发现的地址并不会使用这个静态配置，需要改成动态配置。
-- 启动服务后，普罗米修斯监控服务通过访问：[http://localhost:20888](http://localhost:20888) 即可拉取数据
+也可以使用普罗米修斯的图形界面来查询指标数据如下图所示：
+
### 可视化页面
-也可以使用 Grafana、Prometheus 等实现可视化指标监测，具体请参考以下可视化任务示例：
+也可以使用 Grafana可视化指标监测，下面以Grafana可视化为例：
+Dubbo可观测性面板可以在Grafana官网的模板库中可以找到，您可以直接导入如下模版，并配置好数据源即可。
+[https://grafana.com/grafana/dashboards/18051](https://grafana.com/grafana/dashboards/18051)
+
+
+
+
-* [Admin 任务链接]()
-* [Grafana 任务链接]()
-* [Prometheus 任务链接]()
## Tracing
全链路追踪对于监测分布式系统运行状态具有非常重要的价值，Dubbo 通过 Filter 拦截器实现了请求运行时的埋点跟踪，通过将跟踪数据导出到一些主流实现如
Zipkin、Skywalking、Jaeger 等，可以实现全链路跟踪数据的分析与可视化展示。
diff --git a/static/imgs/v3/advantages/grafana-dashboard-1.png
b/static/imgs/v3/advantages/grafana-dashboard-1.png
new file mode 100644
index 0000000000..ff38ba6a26
Binary files /dev/null and b/static/imgs/v3/advantages/grafana-dashboard-1.png
differ
diff --git a/static/imgs/v3/advantages/grafana-dashboard-2.png
b/static/imgs/v3/advantages/grafana-dashboard-2.png
new file mode 100644
index 0000000000..049ae9a354
Binary files /dev/null and b/static/imgs/v3/advantages/grafana-dashboard-2.png
differ
diff --git a/static/imgs/v3/advantages/metrics.png
b/static/imgs/v3/advantages/metrics.png
new file mode 100644
index 0000000000..bab6bf959d
Binary files /dev/null and b/static/imgs/v3/advantages/metrics.png differ
diff --git a/static/imgs/v3/advantages/prometheus.png
b/static/imgs/v3/advantages/prometheus.png
new file mode 100644
index 0000000000..850edef330
Binary files /dev/null and b/static/imgs/v3/advantages/prometheus.png differ
