Skip to content

Commit 2f92f5b

Browse files
nicecuinicecui
authored
chore: move db status to OSS documentation (#1966)
1 parent 324816a commit 2f92f5b

File tree

5 files changed

+100
-82
lines changed

5 files changed

+100
-82
lines changed

‎docs/enterprise/deployments-administration/monitoring/check-db-status.md‎

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,5 @@ description: Check GreptimeDB health status, deployment status, and runtime metr
55

66
# Check GreptimeDB Status
77

8-
GreptimeDB provides a series of HTTP endpoints to query the operational status of GreptimeDB.
9-
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`.
10-
11-
## Check if GreptimeDB is running normally
12-
13-
You can use the `/health` endpoint to check if GreptimeDB is running normally.
14-
An HTTP status code `200 OK` indicates that GreptimeDB is running normally.
15-
16-
Example:
17-
18-
```bash
19-
curl -i -X GET http://127.0.0.1:4000/health
20-
HTTP/1.1 200 OK
21-
content-type: application/json
22-
content-length: 2
23-
date: Tue, 31 Dec 2024 02:15:22 GMT
24-
25-
{}
26-
```
27-
28-
For more information about the health check endpoint, please refer to [the Health endpoint](/reference/http-endpoints.md#health-check).
29-
30-
## Check GreptimeDB status
31-
32-
You can use the `/status` endpoint to check the deployment status of GreptimeDB.
33-
34-
```bash
35-
curl -X GET http://127.0.0.1:4000/status | jq
36-
37-
{
38-
"source_time": "2024-12-27T07:57:47Z",
39-
"commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8",
40-
"branch": "main",
41-
"rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)",
42-
"hostname": "127.0.0.1",
43-
"version": "0.12.0"
44-
}
45-
```
46-
47-
Please refer to [the Status endpoint](/reference/http-endpoints.md#status) for more details.
8+
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.
489

‎docs/user-guide/deployments-administration/monitoring/check-db-status.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
keywords: [GreptimeDB health check, GreptimeDB status, GreptimeDB deployment status, GreptimeDB metrics]
3+
description: Check GreptimeDB health status, deployment status, and runtime metrics through HTTP endpoints.
4+
---
5+
6+
# Check GreptimeDB Status
7+
8+
GreptimeDB provides a series of HTTP endpoints to query the operational status of GreptimeDB.
9+
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`.
10+
11+
## Check if GreptimeDB is running normally
12+
13+
You can use the `/health` endpoint to check if GreptimeDB is running normally.
14+
An HTTP status code `200 OK` indicates that GreptimeDB is running normally.
15+
16+
Example:
17+
18+
```bash
19+
curl -i -X GET http://127.0.0.1:4000/health
20+
HTTP/1.1 200 OK
21+
content-type: application/json
22+
content-length: 2
23+
date: Tue, 31 Dec 2024 02:15:22 GMT
24+
25+
{}
26+
```
27+
28+
For more information about the health check endpoint, please refer to [the Health endpoint](/reference/http-endpoints.md#health-check).
29+
30+
## Check GreptimeDB status
31+
32+
You can use the `/status` endpoint to check the deployment status of GreptimeDB.
33+
34+
```bash
35+
curl -X GET http://127.0.0.1:4000/status | jq
36+
37+
{
38+
"source_time": "2024-12-27T07:57:47Z",
39+
"commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8",
40+
"branch": "main",
41+
"rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)",
42+
"hostname": "127.0.0.1",
43+
"version": "0.12.0"
44+
}
45+
```
46+
47+
Please refer to [the Status endpoint](/reference/http-endpoints.md#status) for more details.
48+

‎i18n/zh/docusaurus-plugin-content-docs/current/enterprise/deployments-administration/monitoring/check-db-status.md‎

Lines changed: 1 addition & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,4 @@ description: 通过 HTTP 接口检查 GreptimeDB 的健康状态、部署状态
55

66
# 检查 GreptimeDB 状态
77

8-
GreptimeDB 包含了一系列的 HTTP 接口可供查询 GreptimeDB 的运行情况。
9-
以下发起的 HTTP 请求均假定 GreptimeDB 运行在节点 `127.0.0.1` 上，其 HTTP 服务监听默认的 `4000` 端口。
10-
11-
## 查看 GreptimeDB 是否正常运行：
12-
13-
你可以使用 `/health` 接口检查 GreptimeDB 是否正常运行。
14-
HTTP 状态码 `200 OK` 表示 GreptimeDB 运行正常。
15-
16-
例子：
17-
18-
```bash
19-
curl -i -X GET http://127.0.0.1:4000/health
20-
HTTP/1.1 200 OK
21-
content-type: application/json
22-
content-length: 2
23-
date: Tue, 31 Dec 2024 02:15:22 GMT
24-
25-
{}
26-
```
27-
28-
有关健康检查接口的更多信息，请参考[健康检查接口](/reference/http-endpoints.md#健康检查)。
29-
30-
## 查看 GreptimeDB 的部署状态
31-
32-
你可以使用 `/status` 接口检查 GreptimeDB 的部署状态。
33-
34-
```bash
35-
curl -X GET http://127.0.0.1:4000/status | jq
36-
37-
{
38-
"source_time": "2024-12-27T07:57:47Z",
39-
"commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8",
40-
"branch": "main",
41-
"rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)",
42-
"hostname": "127.0.0.1",
43-
"version": "0.12.0"
44-
}
45-
```
46-
47-
有关状态接口的更多信息，请参考[状态接口](/reference/http-endpoints.md#状态)。
48-
49-
8+
请参考[开源 GreptimeDB 文档](/user-guide/deployments-administration/monitoring/check-db-status.md)了解如何检查 GreptimeDB 的健康状态。

‎i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/check-db-status.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
keywords: [GreptimeDB 健康检查, GreptimeDB 运行状态, GreptimeDB 部署状态, GreptimeDB 运行指标]
3+
description: 通过 HTTP 接口检查 GreptimeDB 的健康状态、部署状态和运行指标。
4+
---
5+
6+
# 检查 GreptimeDB 状态
7+
8+
GreptimeDB 包含了一系列的 HTTP 接口可供查询 GreptimeDB 的运行情况。
9+
以下发起的 HTTP 请求均假定 GreptimeDB 运行在节点 `127.0.0.1` 上，其 HTTP 服务监听默认的 `4000` 端口。
10+
11+
## 查看 GreptimeDB 是否正常运行：
12+
13+
你可以使用 `/health` 接口检查 GreptimeDB 是否正常运行。
14+
HTTP 状态码 `200 OK` 表示 GreptimeDB 运行正常。
15+
16+
例子：
17+
18+
```bash
19+
curl -i -X GET http://127.0.0.1:4000/health
20+
HTTP/1.1 200 OK
21+
content-type: application/json
22+
content-length: 2
23+
date: Tue, 31 Dec 2024 02:15:22 GMT
24+
25+
{}
26+
```
27+
28+
有关健康检查接口的更多信息，请参考[健康检查接口](/reference/http-endpoints.md#健康检查)。
29+
30+
## 查看 GreptimeDB 的部署状态
31+
32+
你可以使用 `/status` 接口检查 GreptimeDB 的部署状态。
33+
34+
```bash
35+
curl -X GET http://127.0.0.1:4000/status | jq
36+
37+
{
38+
"source_time": "2024-12-27T07:57:47Z",
39+
"commit": "b4bd34c530d62b95346a26a9470c03b9f6fb15c8",
40+
"branch": "main",
41+
"rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)",
42+
"hostname": "127.0.0.1",
43+
"version": "0.12.0"
44+
}
45+
```
46+
47+
有关状态接口的更多信息，请参考[状态接口](/reference/http-endpoints.md#状态)。
48+
49+

‎sidebars.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ const sidebars: SidebarsConfig = {
336336
id: 'user-guide/deployments-administration/monitoring/overview',
337337
label: 'Overview',
338338
},
339+
'user-guide/deployments-administration/monitoring/check-db-status',
339340
'user-guide/deployments-administration/monitoring/cluster-monitoring-deployment',
340341
'user-guide/deployments-administration/monitoring/export-metrics',
341342
'user-guide/deployments-administration/monitoring/tracing',

0 commit comments

Comments
 (0)