Skip to content

Commit 9f64673

Browse files
authored
feat: add monitoring system documentation for OpenIM (#298)
* feat: add monitoring system documentation for OpenIM * feat: add monitoring system documentation for OpenIM
1 parent acf4b99 commit 9f64673

7 files changed

Lines changed: 80 additions & 0 deletions

File tree

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: '运维系统'
3+
sidebar_position: 11
4+
---
5+
6+
7+
8+
## 组件说明
9+
10+
| 组件名称 | 组件说明 | 部署说明 |
11+
|-------------|-----------------------------------------|--------------------------------------|
12+
| prometheus | 用于收集和存储指标数据的监控系统组件 | 需手动启用 |
13+
| alertmanager | 管理和发送告警的组件 | 需手动启用 |
14+
| grafana | 用于展示监控数据的仪表板组件 | 需手动启用 |
15+
| node-exporter | 用于采集节点(如服务器)指标信息 | 需手动启用 |
16+
17+
## 启动监控
18+
19+
### 1.启动组件
20+
21+
目前`OpenIM`使用的监控告警组件为`prometheus``alertmanager``grafana``node_exporter`。在使用`docker compose up -d`启动组件时,默认**不会**启动监控组件。如需启动监控组件,需要使用命令为:
22+
23+
```sh
24+
docker compose --profile m up -d
25+
```
26+
27+
> 注意:以上方式不适用于windows系统。如果需要在windows系统中启用监控组件,需要自行修改docker-compose.yml中监控组件的网络模式,并映射相应的端口,最后将prometheus.yml中的`127.0.0.1`替换为内网ip地址。
28+
29+
### 2.Grafana导入OpenIM主要指标数据
30+
31+
#### 登录grafana
32+
33+
先登录管理后台,再点击左侧数据监控菜单,输入默认用户名(admin)和密码(admin)登入grafana.
34+
35+
也可以直接访问`your_ip:13000`进行访问,将`youre_ip`改为部署机器的ip地址。
36+
37+
![PC Web Interface](./assets/login1.png)
38+
39+
#### 添加Prometheus数据源
40+
41+
如下图,在左侧菜单栏找到`Connections/Add new connection`,在输入框内输入`prometheus`添加数据源,并输入Prometheus数据源的URL: http://your_ip:19090 (19090为Prometheus默认端口) ,点击"Save and Test"保存.
42+
![PC Web Interface](./assets/database.png)
43+
44+
![PC Web Interface](./assets/database2.png)
45+
46+
#### **导入dashboard**
47+
48+
在左侧菜单栏选择`Dashboards`,点击`Create Dashboard`按钮,再点击`Import dashboard`导入仪表盘。
49+
50+
![dashboard1](./assets/dashboard.png)
51+
52+
有两种方式导入`OpenIM`默认的仪表盘:
53+
54+
1. 拷贝 https://github.com/openimsdk/open-im-server/tree/main/config/grafana-template/Demo.json 内容到`Import via dashboard JSON model`区域。
55+
2. 点击`Upload dashboard JSON file`,上传`open-im-server/config/grafana-template/Demo.json`文件。
56+
57+
接着点击load按钮
58+
59+
![dashboard2](./assets/dashboard2.png)
60+
61+
选择刚刚添加的 Data Source,再点击`Import` 即可导入指标信息,如下图
62+
63+
![dashboard3](./assets/dashboard3.png)
64+
65+
至此,`OpenIM`的主要监控指标配置完毕。
66+
67+
### 3.Grafana导入node exporter指标数据
68+
69+
点击左侧菜单栏的`Dashboard`,选择右侧`New`下拉框中的`Import`
70+
71+
![image-20260320173607074](./assets/dashboard4.png)
72+
73+
`Grafana.com dashboard URL or ID`输入框中填入`1860`,点击右边的`Load`,再点击`Import`
74+
75+
![image-20260320174708460](./assets/dashboard5.png)
76+
77+
node-exporter指标信息,如下图
78+
![image-20260320175028356](./assets/dashboard6.png)
79+
80+
14.2 KB
Loading
40.8 KB
Loading
18.6 KB
Loading
-56.8 KB
Loading
97.9 KB
Loading
442 KB
Loading

0 commit comments

Comments
 (0)