This is an automated email from the ASF dual-hosted git repository.
xcsnx pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new e1bafa6408e [type:feat]add instance doc (#1087)
e1bafa6408e is described below
commit e1bafa6408e5f7e3af860183be2f443e1d4f8ec6
Author: xchoox <[email protected]>
AuthorDate: Sat Oct 11 13:48:45 2025 +0800
[type:feat]add instance doc (#1087)
* add instance doc
* fix instance doc
---
docs/user-guide/admin-usage/instance.md | 33 +++++++++++++++++++++
.../current/user-guide/admin-usage/instance.md | 33 +++++++++++++++++++++
.../basicConfig/instance/instance-visual.png | Bin 0 -> 46983 bytes
3 files changed, 66 insertions(+)
diff --git a/docs/user-guide/admin-usage/instance.md
b/docs/user-guide/admin-usage/instance.md
new file mode 100644
index 00000000000..4ed55bf575e
--- /dev/null
+++ b/docs/user-guide/admin-usage/instance.md
@@ -0,0 +1,33 @@
+# Service Health Status Visualization
+
+## 1. Background & Description
+
+Currently, Apache ShenYu Admin manages both the services reported by the
Client and the Apache ShenYu gateway. However, the management of this series of
services by ShenYu Admin is relatively lacking, especially in terms of
visualization.
+
+Apache ShenYu Admin now supports monitoring and visualizing the liveness
status of both the ShenYu Client and the Apache ShenYu gateway.
+
+## 2.Enabling the Heartbeat Check Service
+
+Monitoring the liveness status requires the Shenyu Client and gateway to
report heartbeat information. The Shenyu Client and gateway using HTTP and
WebSocket data synchronization methods already support heartbeat reporting
without additional configuration.
+
+However, the gateway using middleware data synchronization still requires
manual configuration for heartbeat reporting. The configuration method is as
follows:
+
+### 1.Configuration Settings
+
+Open the gateway's `application.yml` file and find the heartbeat configuration
item. Fill in the admin's IP address and login password.
+
+```yaml
+ heartbeat:
+ enabled: true
+ serverLists: http://localhost:9095
+ props:
+ username: admin
+ password: 123456
+```
+
+## 2.Visualization Interface
+
+Users can log in to the shenyu-admin backend, select [Basic Configuration -
Instance Management], and view the instance status overview.
+
+<img src="/img/shenyu/basicConfig/instance/instance-visual.png" width="80%"
height="50%" />
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/instance.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/instance.md
new file mode 100644
index 00000000000..4c0c2ca773c
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/instance.md
@@ -0,0 +1,33 @@
+# 服务健康状态可视化
+
+## 1. 背景与说明
+
+目前Apache ShenYu Admin同时管理Client上报服务与Apache ShenYu网关，但目前ShenYu
Admin对这一系列服务的管理较为缺失，特别是可视化管理方面。
+
+现在Apache ShenYu Admin已经支持对Client和Apache ShenYu网关存活状态的监测和可视化。
+
+## 2.启用心跳检测服务
+
+存活状态的监测需要Shenyu Client和网关上报心跳信息，其中Shenyu
Client、网关采用http和websocket数据同步的方式已经支持心跳上报，无需额外配置。
+
+但网关采用中间件的数据同步方式仍需手动设置心跳上报配置，配置方法如下：
+
+### 1.配置填写
+
+打开网关的```application.yml``` 文件找到 ```heartbeat``` 配置项。填写admin的ip地址和登录密码
+
+```yaml
+ heartbeat:
+ enabled: true
+ serverLists: http://localhost:9095
+ props:
+ username: admin
+ password: 123456
+```
+
+## 2.可视化界面
+
+用户登录shenyu-admin后台，选择【基础配置-实例管理】，即可看见实例状态总览
+
+<img src="/img/shenyu/basicConfig/instance/instance-visual.png" width="80%"
height="50%" />
+
diff --git a/static/img/shenyu/basicConfig/instance/instance-visual.png
b/static/img/shenyu/basicConfig/instance/instance-visual.png
new file mode 100644
index 00000000000..f58b268f945
Binary files /dev/null and
b/static/img/shenyu/basicConfig/instance/instance-visual.png differ
