Skip to content

Commit 10565f6

Browse files
authored
Update README.md
1 parent 3675e99 commit 10565f6

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,24 @@
99

1010
访问 [WIKI](http://www.sofastack.tech/sofa-lookout/docs/Home) 查看完整的文档使用指南。
1111

12-
SOFALookout(已开源部分)是一个利用多维度的 metrics 对目标系统进行度量和监控的项目。SOFALookout 的多维度 metrics 参考[Metrics2.0 标准](http://metrics20.org/)。SOFALookout 项目分为客户端部分与服务器端部分。
13-
12+
SOFALookout(已开源部分)是一个利用多维度的 metrics 对目标系统进行度量和监控的项目。SOFALookout 的多维度 metrics 参考[Metrics2.0 标准](http://metrics20.org/)
13+
14+
```
15+
+----------------+
16+
| Lookout Client +----+
17+
+----------------+ |
18+
+----------------+ |
19+
| Prometheus SDK +----+ +-------------------+ +------------+ +------------------+ +-----------+
20+
+----------------+ +--> Lookout Gateway +---> DB(ES/...)<--+ Lookout Server <--+ Grafana |
21+
+----------------+ | +-------------------+ +------------+ +------------------+ +-----------+
22+
| Metricbeat +----+
23+
+----------------+ |
24+
+----------------+ |
25+
| ... +----+
26+
+----------------+
27+
```
28+
29+
SOFALookout 项目分为客户端部分与服务器端部分:
1430
- 客户端是一个 Java 的类库,可以将它植入您的应用代码中采集 metrics 信息,[客户端更多详情](./client/README.md)
1531
- 服务端代码(Metrics)部分,对 Metrics 数据进行收集、加工、存储和查询等处理,另外结合 [grafana](https://grafana.com),可做数据可视化展示。
1632

@@ -28,14 +44,9 @@ SOFALookout(已开源部分)是一个利用多维度的 metrics 对目标系
2844
会持续开源 tracing,eventing 功能。
2945

3046
## 编译
31-
- 客户端代码编译: `cd client && mvn clean install -DskipTests`
32-
- 服务器端代码编译:
33-
- all-in-one模式: `./boot/all-ine-one-bootstrap/build.sh`, 打包结果在`boot/all-in-one-bootstrap/target/xxx-executable-ark.jar`
34-
- metrics-server: `mvn clean install -DskipTests -am -pl boot/metrics-server-bootstrap`
35-
- gateway: `mvn clean install -DskipTests -am -pl boot/gateway-bootstrap`
47+
- 代码编译: 至少Maven 3.2.5+, JDK Version 8+;
48+
- all-in-one 启动模块编译: `./boot/all-ine-one-bootstrap/build.sh`, 打包结果在`boot/all-in-one-bootstrap/target/xxx-executable-ark.jar`
3649

37-
> 要求至少Maven 3.2.5+, JDK Version 8+;
38-
3950
## 致谢
4051
Lookout 的 promQL 相关解析逻辑是从 Prometheus 移植而来,做了一些优化和改进, 感谢 Prometheus 开源了如此易用和强大的 golang 版本的 QL 实现
4152

0 commit comments

Comments
 (0)