diff --git a/docs/guides/gettingStarted/admin.md b/docs/guides/gettingStarted/admin.md new file mode 100644 index 0000000000..97e6264e2e --- /dev/null +++ b/docs/guides/gettingStarted/admin.md @@ -0,0 +1,80 @@ +--- +title: '运维系统' +sidebar_position: 11 +--- + + + +## 组件说明 + +| 组件名称 | 组件说明 | 部署说明 | +|-------------|-----------------------------------------|--------------------------------------| +| prometheus | 用于收集和存储指标数据的监控系统组件 | 需手动启用 | +| alertmanager | 管理和发送告警的组件 | 需手动启用 | +| grafana | 用于展示监控数据的仪表板组件 | 需手动启用 | +| node-exporter | 用于采集节点(如服务器)指标信息 | 需手动启用 | + +## 启动监控 + +### 1.启动组件 + +目前`OpenIM`使用的监控告警组件为`prometheus`、`alertmanager`、`grafana`、`node_exporter`。在使用`docker compose up -d`启动组件时,默认**不会**启动监控组件。如需启动监控组件,需要使用命令为: + +```sh +docker compose --profile m up -d +``` + +> 注意:以上方式不适用于windows系统。如果需要在windows系统中启用监控组件,需要自行修改docker-compose.yml中监控组件的网络模式,并映射相应的端口,最后将prometheus.yml中的`127.0.0.1`替换为内网ip地址。 + +### 2.Grafana导入OpenIM主要指标数据 + +#### 登录grafana + +先登录管理后台,再点击左侧数据监控菜单,输入默认用户名(admin)和密码(admin)登入grafana. + +也可以直接访问`your_ip:13000`进行访问,将`youre_ip`改为部署机器的ip地址。 + +![PC Web Interface](./assets/login1.png) + +#### 添加Prometheus数据源 + +如下图,在左侧菜单栏找到`Connections/Add new connection`,在输入框内输入`prometheus`添加数据源,并输入Prometheus数据源的URL: http://your_ip:19090 (19090为Prometheus默认端口) ,点击"Save and Test"保存. +![PC Web Interface](./assets/database.png) + +![PC Web Interface](./assets/database2.png) + +#### **导入dashboard** + +在左侧菜单栏选择`Dashboards`,点击`Create Dashboard`按钮,再点击`Import dashboard`导入仪表盘。 + +![dashboard1](./assets/dashboard.png) + +有两种方式导入`OpenIM`默认的仪表盘: + +1. 拷贝 https://github.com/openimsdk/open-im-server/tree/main/config/grafana-template/Demo.json 内容到`Import via dashboard JSON model`区域。 +2. 点击`Upload dashboard JSON file`,上传`open-im-server/config/grafana-template/Demo.json`文件。 + +接着点击load按钮 + +![dashboard2](./assets/dashboard2.png) + +选择刚刚添加的 Data Source,再点击`Import` 即可导入指标信息,如下图 + +![dashboard3](./assets/dashboard3.png) + +至此,`OpenIM`的主要监控指标配置完毕。 + +### 3.Grafana导入node exporter指标数据 + +点击左侧菜单栏的`Dashboard`,选择右侧`New`下拉框中的`Import`。 + +![image-20260320173607074](./assets/dashboard4.png) + +在`Grafana.com dashboard URL or ID`输入框中填入`1860`,点击右边的`Load`,再点击`Import`。 + +![image-20260320174708460](./assets/dashboard5.png) + +node-exporter指标信息,如下图 +![image-20260320175028356](./assets/dashboard6.png) + + diff --git a/docs/guides/gettingStarted/assets/dashboard.png b/docs/guides/gettingStarted/assets/dashboard.png index 58683220ce..b211baa46b 100644 Binary files a/docs/guides/gettingStarted/assets/dashboard.png and b/docs/guides/gettingStarted/assets/dashboard.png differ diff --git a/docs/guides/gettingStarted/assets/dashboard3.png b/docs/guides/gettingStarted/assets/dashboard3.png index acb8d337f8..0c40143826 100644 Binary files a/docs/guides/gettingStarted/assets/dashboard3.png and b/docs/guides/gettingStarted/assets/dashboard3.png differ diff --git a/docs/guides/gettingStarted/assets/dashboard4.png b/docs/guides/gettingStarted/assets/dashboard4.png index 5c808429ac..7b2f467ef3 100644 Binary files a/docs/guides/gettingStarted/assets/dashboard4.png and b/docs/guides/gettingStarted/assets/dashboard4.png differ diff --git a/docs/guides/gettingStarted/assets/dashboard5.png b/docs/guides/gettingStarted/assets/dashboard5.png index cb28e11023..6c88979ced 100644 Binary files a/docs/guides/gettingStarted/assets/dashboard5.png and b/docs/guides/gettingStarted/assets/dashboard5.png differ diff --git a/docs/guides/gettingStarted/assets/dashboard6.png b/docs/guides/gettingStarted/assets/dashboard6.png index 11af54ba2f..a05e8f432f 100644 Binary files a/docs/guides/gettingStarted/assets/dashboard6.png and b/docs/guides/gettingStarted/assets/dashboard6.png differ diff --git a/docs/guides/gettingStarted/assets/login1.png b/docs/guides/gettingStarted/assets/login1.png index c09dfdffe4..2fd8cb11f5 100644 Binary files a/docs/guides/gettingStarted/assets/login1.png and b/docs/guides/gettingStarted/assets/login1.png differ