add chinese docker compose quick start md

README.md

@@ -1,7 +1,16 @@
-# mocha
+Mocha
+=====
+
+[![codecov](https://codecov.io/gh/dotnetcore/mocha/branch/main/graph/badge.svg)](https://codecov.io/gh/openmocha/mocha)
+
 Mocha is an application performance monitor tools based on [OpenTelemetry](https://opentelemetry.io), which also provides a scalable platform for observability data analysis and storage.
 
-# functional architecture
+## Quick Start
+In the beta phase, we provide a Docker Compose file for users to experience our system locally.
+
+[Quick Start 简体中文](./docs/quick-start/docker-compose/quick-start.zh-CN.md)
+
+## Functional architecture
 ![](./docs/assets/functional_architecture.png)
 
 The set of features that Mocha will provide:
@@ -21,7 +30,7 @@ The set of features that Mocha will provide:
   - Alert notifications
 - Metrics/Logs/Traces data explore
 
-# technical architecture
+## Technical architecture
 ![](./docs/assets/technical_architecture.png)
 
 The components of Mocha are as follows:
@@ -32,8 +41,8 @@ The components of Mocha are as follows:
 - Mocha Manager : Consisting of a manager server, dashboard, and ETCD for cluster metadata and data analysis rules storage.
 - OTel SDK / Collector : Open-source OpenTelemetry collection kits
 
-# contribute
+## Contribute
 One of the easiest ways to contribute is to participate in discussions and discuss issues. You can also contribute by submitting pull requests with code changes.
 
-# license
-Mocha is under the MIT license. See the [LICENSE](LICENSE) file for details.
+## License
+Mocha is under the MIT license. See the [LICENSE](LICENSE) file for details.

docs/quick-start/docker-compose/quick-start.zh-CN.md

@@ -0,0 +1,42 @@
+## 启动项目
+
+在项目根目录下，执行以下命令启动项目：
+
+```bash
+docker-compose up -d
+```
+
+启动成功后，可以看到以下容器：
+
++ distributor: 提供用于接收 OTLP 数据的 gRPC API
++ jaeger-query: 提供用于接收 Jaeger 查询协议的 HTTP API
++ mysql: 用于存储数据
++ grafana: 用于展示数据
+
+## Trace 数据的发送
+
+将 SDK 的 OTLP exporter 配置为 `http://localhost:4317` 即可将数据发送到 distributor。
+
+## Trace 数据的查询
+
+我们实现了支持 Jaeger 查询协议的 API，因此可以直接在 Grafana 中配置 Jaeger 数据源。
+
+访问 http://localhost:3000/ 即可看到grafana的登录页面。用户名和密码都是admin。
+
+登录后，点击左侧的菜单，选择 Data Sources，然后点击 Add data source。
+
+![](./asserts/add-jaeger-data-source.png)
+
+![](./asserts/add-jaeger-data-source-2.png)
+
+选择 Jaeger。
+![](./asserts/add-jaeger-data-source-3.png)
+
+配置 Jaeger 数据源的 URL 为 http://jaeger-query:5775。
+![](./asserts/add-jaeger-data-source-4.png)
+
+点击 Save & Test，如果显示如下信息，则说明配置成功。
+![](./asserts/add-jaeger-data-source-5.png)
+
+这边建议先往 Distributor 发送一些数据，然后再点击 Save & Test，否则会报错。
+![](./asserts/add-jaeger-data-source-error.png)