diff --git a/docs/enterprise/deployments-administration/monitoring/check-db-status.md b/docs/enterprise/deployments-administration/monitoring/check-db-status.md index e6268b307..281eda9fd 100644 --- a/docs/enterprise/deployments-administration/monitoring/check-db-status.md +++ b/docs/enterprise/deployments-administration/monitoring/check-db-status.md @@ -5,44 +5,5 @@ description: Check GreptimeDB health status, deployment status, and runtime metr # Check GreptimeDB Status -GreptimeDB provides a series of HTTP endpoints to query the operational status of GreptimeDB. -The following HTTP requests assume that GreptimeDB is running on node `127.0.0.1` with the HTTP service listening on the default port `4000`. - -## Check if GreptimeDB is running normally - -You can use the `/health` endpoint to check if GreptimeDB is running normally. -An HTTP status code `200 OK` indicates that GreptimeDB is running normally. - -Example: - -```bash -curl -i -X GET http://127.0.0.1:4000/health -HTTP/1.1 200 OK -content-type: application/json -content-length: 2 -date: Tue, 31 Dec 2024 02:15:22 GMT - -{} -``` - -For more information about the health check endpoint, please refer to [the Health endpoint](/reference/http-endpoints.md#health-check). - -## Check GreptimeDB status - -You can use the `/status` endpoint to check the deployment status of GreptimeDB. - -```bash -curl -X GET http://127.0.0.1:4000/status | jq - -{ - "source_time": "2024-12-27T07:57:47Z", - "commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8", - "branch": "main", - "rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)", - "hostname": "127.0.0.1", - "version": "0.12.0" -} -``` - -Please refer to [the Status endpoint](/reference/http-endpoints.md#status) for more details. +Please refer to the [OSS GreptimeDB documentation](/user-guide/deployments-administration/monitoring/check-db-status.md) for details on how to check the health status of GreptimeDB. diff --git a/docs/user-guide/deployments-administration/monitoring/check-db-status.md b/docs/user-guide/deployments-administration/monitoring/check-db-status.md new file mode 100644 index 000000000..e6268b307 --- /dev/null +++ b/docs/user-guide/deployments-administration/monitoring/check-db-status.md @@ -0,0 +1,48 @@ +--- +keywords: [GreptimeDB health check, GreptimeDB status, GreptimeDB deployment status, GreptimeDB metrics] +description: Check GreptimeDB health status, deployment status, and runtime metrics through HTTP endpoints. +--- + +# Check GreptimeDB Status + +GreptimeDB provides a series of HTTP endpoints to query the operational status of GreptimeDB. +The following HTTP requests assume that GreptimeDB is running on node `127.0.0.1` with the HTTP service listening on the default port `4000`. + +## Check if GreptimeDB is running normally + +You can use the `/health` endpoint to check if GreptimeDB is running normally. +An HTTP status code `200 OK` indicates that GreptimeDB is running normally. + +Example: + +```bash +curl -i -X GET http://127.0.0.1:4000/health +HTTP/1.1 200 OK +content-type: application/json +content-length: 2 +date: Tue, 31 Dec 2024 02:15:22 GMT + +{} +``` + +For more information about the health check endpoint, please refer to [the Health endpoint](/reference/http-endpoints.md#health-check). + +## Check GreptimeDB status + +You can use the `/status` endpoint to check the deployment status of GreptimeDB. + +```bash +curl -X GET http://127.0.0.1:4000/status | jq + +{ + "source_time": "2024-12-27T07:57:47Z", + "commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8", + "branch": "main", + "rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)", + "hostname": "127.0.0.1", + "version": "0.12.0" +} +``` + +Please refer to [the Status endpoint](/reference/http-endpoints.md#status) for more details. + diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments-administration/monitoring/check-db-status.md b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments-administration/monitoring/check-db-status.md index 7a38490be..5e29296b4 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments-administration/monitoring/check-db-status.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments-administration/monitoring/check-db-status.md @@ -5,45 +5,4 @@ description: 通过 HTTP 接口检查 GreptimeDB 的健康状态、部署状态 # 检查 GreptimeDB 状态 -GreptimeDB 包含了一系列的 HTTP 接口可供查询 GreptimeDB 的运行情况。 -以下发起的 HTTP 请求均假定 GreptimeDB 运行在节点 `127.0.0.1` 上，其 HTTP 服务监听默认的 `4000` 端口。 - -## 查看 GreptimeDB 是否正常运行： - -你可以使用 `/health` 接口检查 GreptimeDB 是否正常运行。 -HTTP 状态码 `200 OK` 表示 GreptimeDB 运行正常。 - -例子： - -```bash -curl -i -X GET http://127.0.0.1:4000/health -HTTP/1.1 200 OK -content-type: application/json -content-length: 2 -date: Tue, 31 Dec 2024 02:15:22 GMT - -{} -``` - -有关健康检查接口的更多信息，请参考[健康检查接口](/reference/http-endpoints.md#健康检查)。 - -## 查看 GreptimeDB 的部署状态 - -你可以使用 `/status` 接口检查 GreptimeDB 的部署状态。 - -```bash -curl -X GET http://127.0.0.1:4000/status | jq - -{ - "source_time": "2024-12-27T07:57:47Z", - "commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8", - "branch": "main", - "rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)", - "hostname": "127.0.0.1", - "version": "0.12.0" -} -``` - -有关状态接口的更多信息，请参考[状态接口](/reference/http-endpoints.md#状态)。 - - +请参考[开源 GreptimeDB 文档](/user-guide/deployments-administration/monitoring/check-db-status.md)了解如何检查 GreptimeDB 的健康状态。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/check-db-status.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/check-db-status.md new file mode 100644 index 000000000..7a38490be --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/check-db-status.md @@ -0,0 +1,49 @@ +--- +keywords: [GreptimeDB 健康检查, GreptimeDB 运行状态, GreptimeDB 部署状态, GreptimeDB 运行指标] +description: 通过 HTTP 接口检查 GreptimeDB 的健康状态、部署状态和运行指标。 +--- + +# 检查 GreptimeDB 状态 + +GreptimeDB 包含了一系列的 HTTP 接口可供查询 GreptimeDB 的运行情况。 +以下发起的 HTTP 请求均假定 GreptimeDB 运行在节点 `127.0.0.1` 上，其 HTTP 服务监听默认的 `4000` 端口。 + +## 查看 GreptimeDB 是否正常运行： + +你可以使用 `/health` 接口检查 GreptimeDB 是否正常运行。 +HTTP 状态码 `200 OK` 表示 GreptimeDB 运行正常。 + +例子： + +```bash +curl -i -X GET http://127.0.0.1:4000/health +HTTP/1.1 200 OK +content-type: application/json +content-length: 2 +date: Tue, 31 Dec 2024 02:15:22 GMT + +{} +``` + +有关健康检查接口的更多信息，请参考[健康检查接口](/reference/http-endpoints.md#健康检查)。 + +## 查看 GreptimeDB 的部署状态 + +你可以使用 `/status` 接口检查 GreptimeDB 的部署状态。 + +```bash +curl -X GET http://127.0.0.1:4000/status | jq + +{ + "source_time": "2024-12-27T07:57:47Z", + "commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8", + "branch": "main", + "rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)", + "hostname": "127.0.0.1", + "version": "0.12.0" +} +``` + +有关状态接口的更多信息，请参考[状态接口](/reference/http-endpoints.md#状态)。 + + diff --git a/sidebars.ts b/sidebars.ts index f42be680b..977536b53 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -336,6 +336,7 @@ const sidebars: SidebarsConfig = { id: 'user-guide/deployments-administration/monitoring/overview', label: 'Overview', }, + 'user-guide/deployments-administration/monitoring/check-db-status', 'user-guide/deployments-administration/monitoring/cluster-monitoring-deployment', 'user-guide/deployments-administration/monitoring/export-metrics', 'user-guide/deployments-administration/monitoring/tracing',