[dolphinscheduler] 03/09: [doc] Add doc about how to use healthcheck endpoints (#10592)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhongjiajie pushed a commit to branch 3.0.0-prepare
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git

commit b88b522827fc2a6b1ce3c55075128744326a4fc3
Author: xiangzihao <46...@qq.com>
AuthorDate: Fri Jun 24 16:56:26 2022 +0800

    [doc] Add doc about how to use healthcheck endpoints (#10592)
    
    (cherry picked from commit 33cc68ed4a4d6cae7883c637e37e6eafb7c2b5e1)
---
 docs/docs/en/guide/healthcheck.md | 41 +++++++++++++++++++++++++++++++++++++++
 docs/docs/zh/guide/healthcheck.md | 41 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)

diff --git a/docs/docs/en/guide/healthcheck.md b/docs/docs/en/guide/healthcheck.md
new file mode 100644
index 0000000000..fdb6efd456
--- /dev/null
+++ b/docs/docs/en/guide/healthcheck.md
@@ -0,0 +1,41 @@
+# Health Check
+
+## Background
+
+Health check are designed to provide a unique way to check the health of the dolphinscheduler service. It includes the health status of modules, such as DB, cache, network, etc.
+
+## Endpoint
+
+### API-Server
+
+```shell
+curl --request GET 'http://localhost:12345/dolphinscheduler/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Master-Server
+
+```shell
+curl --request GET 'http://localhost:5679/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Worker-Server
+
+```shell
+curl --request GET 'http://localhost:1235/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Alert-Server
+
+```shell
+curl --request GET 'http://localhost:50053/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+> Notice: If you modify the default service port and address, you need to modify the IP+Port to the modified value.
diff --git a/docs/docs/zh/guide/healthcheck.md b/docs/docs/zh/guide/healthcheck.md
new file mode 100644
index 0000000000..59f8d61341
--- /dev/null
+++ b/docs/docs/zh/guide/healthcheck.md
@@ -0,0 +1,41 @@
+# 健康检查
+
+## 背景
+
+运行状况检查旨在提供一种独特的方法来检查 Dolphinscheduler 服务的运行状况。它包括模块的运行状况，例如 DB、缓存、网络等等。
+
+## Endpoint
+
+### API-Server
+
+```shell
+curl --request GET 'http://localhost:12345/dolphinscheduler/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Master-Server
+
+```shell
+curl --request GET 'http://localhost:5679/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Worker-Server
+
+```shell
+curl --request GET 'http://localhost:1235/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+### Alert-Server
+
+```shell
+curl --request GET 'http://localhost:50053/actuator/health'
+
+{"status":"UP","components":{"db":{"status":"UP","details":{"database":"H2","validationQuery":"isValid()"}}}}
+```
+
+> 注意: 如果你修改过默认的服务端口和地址，那么你需要修改 IP+Port 为你修改后的值。