Browse Source

[doc] Add doc about how to use healthcheck endpoints (#10592)

3.1.0-release
xiangzihao 2 years ago committed by GitHub
parent
commit
33cc68ed4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/configs/docsdev.js
  2. 41
      docs/docs/en/guide/healthcheck.md
  3. 41
      docs/docs/zh/guide/healthcheck.md

8
docs/configs/docsdev.js

@ -367,6 +367,10 @@ export default {
title: 'PyDolphinScheduler',
link: '/python/index.html',
},
{
title: 'Health Check',
link: '/en-us/docs/dev/user_doc/guide/healthcheck.html',
},
],
},
{
@ -739,6 +743,10 @@ export default {
title: 'PyDolphinScheduler',
link: '/python/index.html',
},
{
title: '健康检查',
link: '/zh-cn/docs/dev/user_doc/guide/healthcheck.html',
},
],
},
{

41
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.

41
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 为你修改后的值。
Loading…
Cancel
Save