doc: add setup details
Signed-off-by: fanzu8 <tuzengbing@gmail.com>
This commit is contained in:
tuzengbing
parent
1a95972842
commit
b84209272b
14
README.md
14
README.md
|
|
@ -24,23 +24,23 @@
|
|||
如果你想更进一步了解 HUATUO 运行机制，架构设计等，可在本地很方便地搭建 HUATUO 完整运行的所有组件，我们提供容器镜像以及简单配置，方便用户开发者快速了解 HUATUO。
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph host
|
||||
subgraph huatuo-bamai
|
||||
subgraph host[宿主机]
|
||||
subgraph huatuo-bamai[huatuo-bamai]
|
||||
A1[【metrics】] <-- "transfer" --> A2[【tracing】]
|
||||
end
|
||||
end
|
||||
|
||||
subgraph storage backends
|
||||
subgraph storage backends[存储后端]
|
||||
A1 -->|:19704| B1[prometheus]
|
||||
A2 -->|:9200| B2[elasticsearch]
|
||||
end
|
||||
|
||||
subgraph grafana_dashboard["grafana panels"]
|
||||
subgraph grafana_dashboard["grafana 监控大盘"]
|
||||
B1 -->|:9090| C1[host, container]
|
||||
B2 -->|:9200| C2[autotracing, events]
|
||||
end
|
||||
|
||||
subgraph browser
|
||||
subgraph browser[浏览器]
|
||||
D[:3000]
|
||||
end
|
||||
|
||||
|
|
@ -49,11 +49,11 @@
|
|||
```
|
||||
<div style="text-align: center; margin: 8px 0 20px 0; color: #777;">
|
||||
<small>
|
||||
HUATUO 组件运行示意<br>
|
||||
HUATUO 组件运行示意图<br>
|
||||
</small>
|
||||
</div>
|
||||
|
||||
为快速搭建运行环境，我们提供一键运行的方式，该命令会启动 elasticsearch, prometheus, grafana 以及 huatuo-bamai 组件。命令执行成功后，打开浏览器访问 http://localhost:3000 即可浏览监控大盘。
|
||||
为快速搭建运行环境，我们提供一键运行的方式，该命令会启动 [elasticsearch](https://www.elastic.co), [prometheus](https://prometheus.io), [grafana](https://grafana.com) 以及 huatuo-bamai 组件。命令执行成功后，打开浏览器访问 [http://localhost:3000](http://localhost:3000) 即可浏览监控大盘。
|
||||
|
||||
```bash
|
||||
$ docker compose --project-directory ./build/docker up
|
||||
|
|
|
|||
50
README_EN.md
50
README_EN.md
|
|
@ -12,15 +12,49 @@ HuaTuo also integrates core technologies such as automated tracing, profiling, a
|
|||
- **Smooth Transition** to Popular Observability Stacks: Provides standard data sources for Prometheus and Pyroscope, integrates with Kubernetes container resources, and automatically correlates Kubernetes labels/annotations with kernel event metrics, eliminating data silos, ensuring seamless integration and analysis across various data sources for comprehensive system monitoring.
|
||||
|
||||
# Getting Started
|
||||
## run
|
||||
HuaTuo provides a convenient way for quick getting started, all in one command as below:
|
||||
```bash
|
||||
$ docker compose --project-directory ./build/docker up
|
||||
```
|
||||
Run it in the project root directory, then open [http://localhost:3000](http://localhost:3000) to view the panels on your browser.
|
||||
- **Instant Experience**
|
||||
If you only care about the underlying principles and not about storage backends or frontend display, we provide a pre-built image containing all necessary components for HUATO's core operation. Just run:
|
||||
|
||||
The upper command starts three dependencies containers: [elasticsearch](https://www.elastic.co), [prometheus](https://prometheus.io), [grafana](https://grafana.com), then compiles and starts huatuo-bamai.
|
||||
- Data related to event-driven operations, such as Autotracing and Events, are stored in elasticsearch
|
||||
```bash
|
||||
$ docker run --privileged --network=host -v /sys:/sys -v /run:/run huatuo/huatuo-bamai:latest
|
||||
```
|
||||
|
||||
- **Quick Setup**
|
||||
If you want to dive deeper into HUATO's operation mechanisms and architecture, you can easily set up all components locally. We provide container images and simple configurations for developers to quickly understand HUATO.
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph host[host]
|
||||
subgraph huatuo-bamai[huatuo-bamai]
|
||||
A1[【metrics】] <-- "transfer" --> A2[【tracing】]
|
||||
end
|
||||
end
|
||||
|
||||
subgraph storage backends[storage backends]
|
||||
A1 -->|:19704| B1[prometheus]
|
||||
A2 -->|:9200| B2[elasticsearch]
|
||||
end
|
||||
|
||||
subgraph grafana_dashboard["grafana panels"]
|
||||
B1 -->|:9090| C1[host, container]
|
||||
B2 -->|:9200| C2[autotracing, events]
|
||||
end
|
||||
|
||||
subgraph browser[browser]
|
||||
D[:3000]
|
||||
end
|
||||
|
||||
C1 --> D
|
||||
C2 --> D
|
||||
```
|
||||
<div style="text-align: center; margin: 8px 0 20px 0; color: #777;">
|
||||
<small>
|
||||
HUATUO Component Workflow<br>
|
||||
</small>
|
||||
</div>
|
||||
|
||||
For a quick setup, we provide a one-command solution to launch [elasticsearch](https://www.elastic.co), [prometheus](https://prometheus.io), [grafana](https://grafana.com) and huatuo-bamai. Once executed, click [http://localhost:3000](http://localhost:3000) to view the monitoring dashboards on your browser.
|
||||
|
||||
- Data related to event-driven operations Autotracing and Events, are stored in elasticsearch
|
||||
- Metrics-related data is actively collected and stored by prometheus
|
||||
- elasticsearch data reporting port: 9200
|
||||
- prometheus data source port: 9090
|
||||
|
|
|
|||
Loading…
Reference in New Issue