You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2020/10/08 10:53:06 UTC

[skywalking] branch master updated: Add a missing link of the health check doc. (#5634)

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

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git


The following commit(s) were added to refs/heads/master by this push:
     new ea3b099  Add a missing link of the health check doc. (#5634)
ea3b099 is described below

commit ea3b0999784228070f0c178edf2f037da5650aa4
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu Oct 8 18:52:11 2020 +0800

    Add a missing link of the health check doc. (#5634)
---
 docs/en/setup/backend/backend-health-check.md | 3 +++
 docs/en/setup/backend/backend-setup.md        | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/docs/en/setup/backend/backend-health-check.md b/docs/en/setup/backend/backend-health-check.md
index 6a663ef..ff94671 100644
--- a/docs/en/setup/backend/backend-health-check.md
+++ b/docs/en/setup/backend/backend-health-check.md
@@ -60,3 +60,6 @@ We could opt to above query to check the readiness of GraphQL.
 OAP has implemented [gRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
 We could use [grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe) or any other tools to check the
 health of OAP gRPC services.
+
+## CLI tool
+Please follow the [CLI doc](https://github.com/apache/skywalking-cli#checkhealth) to get the health status score directly through the `checkhealth` command.
\ No newline at end of file
diff --git a/docs/en/setup/backend/backend-setup.md b/docs/en/setup/backend/backend-setup.md
index 6991e17..65943e8 100755
--- a/docs/en/setup/backend/backend-setup.md
+++ b/docs/en/setup/backend/backend-setup.md
@@ -116,6 +116,10 @@ to improve the meaning of the metrics.
 OAP backend cluster itself underlying is a distributed streaming process system. For helping the Ops team,
 we provide the telemetry for OAP backend itself. Follow [document](backend-telemetry.md) to use it.
 
+At the same time, we provide [Health Check](backend-health-check.md) to get a score for the health status.
+> 0 means healthy, more than 0 means unhealthy 
+> and less than 0 means oap doesn't startup.
+
 ## FAQs
 #### When and why do we need to set Timezone?
 SkyWalking provides downsampling time series metrics features.