Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/enterprise/administration/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
keywords: [Kubernetes deployment, Operator pattern, automated management, cluster deployment, standalone instance, private cloud, public cloud]
description: Overview of deploying GreptimeDB on Kubernetes, including cluster installation, upgrades, and monitoring.
---

# Deploy GreptimeDB on Kubernetes

The deployment process for GreptimeDB Enterprise on Kubernetes is almost the same as the open-source version.
This chapter focuses on the specific deployment configurations and features of the enterprise version.

## Installation

To learn how to start GreptimeDB through Helm Chart, please see the [Install GreptimeDB](./installation.md) page.

## Upgrade

Please visit the [Upgrade GreptimeDB](./upgrade.md) page to learn how to upgrade GreptimeDB enterprise.

Original file line number Diff line number Diff line change
@@ -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.

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
keywords: [monitoring, GreptimeDB monitoring, monitoring metrics, monitoring configuration, monitoring logs]
description: GreptimeDB monitoring overview, introducing GreptimeDB monitoring metrics, configuration, and logs.
---

import DocCardList from '@theme/DocCardList';

# Monitoring

Effective database management relies heavily on monitoring.
You can monitor GreptimeDB using the following methods:

<DocCardList />

This file was deleted.

8 changes: 0 additions & 8 deletions docs/enterprise/deployments/monitoring/check-db-status.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/enterprise/deployments/monitoring/overview.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/enterprise/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ This section provides an overview of the advanced features available in Greptime

## Features

- [Active-Active Failover Disaster Recovery Solution](./administration/disaster-recovery/overview.md): Ensure uninterrupted service and data protection with advanced disaster recovery solution.
- [LDAP Authentication](./deployments/authentication.md): Secure your system with LDAP-based authentication for access management.
- [Audit Logging](./deployments/monitoring/audit-logging.md): Track and monitor
- [Active-Active Failover Disaster Recovery Solution](./deployments-administration/disaster-recovery/overview.md): Ensure uninterrupted service and data protection with advanced disaster recovery solution.
- [LDAP Authentication](./deployments-administration/authentication.md): Secure your system with LDAP-based authentication for access management.
- [Audit Logging](./deployments-administration/monitoring/audit-logging.md): Track and monitor
user activity with detailed audit logs.
- [Automatic region load balance](./autopilot/region-balancer.md): Auto balance
datanodes workload by moving regions between them.
Expand Down
54 changes: 54 additions & 0 deletions docs/reference/http-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,81 @@ Endpoints that is not versioned (under `/v1`). For admin usage like health check
- **Description**: Provides a health check endpoint to verify that the server is running.
- **Usage**: Access this endpoint to check the health status of the server.

Please refer to the [check GreptimeDB health documentation](/enterprise/deployments-administration/monitoring/check-db-status.md#check-if-greptimedb-is-running-normally) for an example.

### Status

- **Path**: `/status`
- **Methods**: `GET`
- **Description**: Retrieves the current status of the server.
- **Usage**: Use this endpoint to obtain server status information.

Please refer to the [Check GreptimeDB status documentation](/enterprise/deployments-administration/monitoring/check-db-status.md#check-greptimedb-status) for an example.

### Metrics

- **Path**: `/metrics`
- **Methods**: `GET`
- **Description**: Exposes Prometheus metrics for monitoring purposes.
- **Usage**: Prometheus can scrape this endpoint to collect metrics data.

Example:

```bash
curl -X GET http://127.0.0.1:4000/metrics

# HELP greptime_app_version app version
# TYPE greptime_app_version gauge
greptime_app_version{app="greptime-edge",short_version="main-b4bd34c5",version="0.12.0"} 1
# HELP greptime_catalog_catalog_count catalog catalog count
# TYPE greptime_catalog_catalog_count gauge
greptime_catalog_catalog_count 1
# HELP greptime_catalog_schema_count catalog schema count
# TYPE greptime_catalog_schema_count gauge
greptime_catalog_schema_count 3
# HELP greptime_flow_run_interval_ms flow run interval in ms
# TYPE greptime_flow_run_interval_ms gauge
greptime_flow_run_interval_ms 1000
# HELP greptime_meta_create_catalog meta create catalog
# TYPE greptime_meta_create_catalog histogram
greptime_meta_create_catalog_bucket{le="0.005"} 1
greptime_meta_create_catalog_bucket{le="0.01"} 1
greptime_meta_create_catalog_bucket{le="0.025"} 1
greptime_meta_create_catalog_bucket{le="0.05"} 1
greptime_meta_create_catalog_bucket{le="0.1"} 1
...
```

### Configuration

- **Path**: `/config`
- **Methods**: `GET`
- **Description**: Retrieves the server's configuration options.
- **Usage**: Access this endpoint to get configuration details.

For example:

```shell
curl http://localhost:4000/config
```

The output contains the configuration information of the GreptimeDB server.

```toml
enable_telemetry = true
user_provider = "static_user_provider:file:user"
init_regions_in_background = false
init_regions_parallelism = 16

[http]
addr = "127.0.0.1:4000"
timeout = "30s"
body_limit = "64MiB"
is_strict_mode = false

# ...
```

### Dashboard

- **Paths**: `/dashboard`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ provider"s. There are various implementations of user providers in GreptimeDB:

- [Static User Provider](./static.md): A simple built-in user provider implementation that finds users from a static
file.
- [LDAP User Provider](/enterprise/deployments/authentication.md): **Enterprise feature.** A user provider implementation that authenticates users against an external LDAP
- [LDAP User Provider](/enterprise/deployments-administration/authentication.md): **Enterprise feature.** A user provider implementation that authenticates users against an external LDAP
server.

Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Deploying nodes in different regions can also meet region-level DR requirements,

:::

For more information about this solution, see [DR solution based on Active-Active Failover](/enterprise/administration/disaster-recovery/dr-solution-based-on-active-active-failover.md).
For more information about this solution, see [DR solution based on Active-Active Failover](/enterprise/deployments-administration/disaster-recovery/dr-solution-based-on-active-active-failover.md).

### DR solution based on cross-region deployment in a single cluster

Expand Down Expand Up @@ -125,6 +125,6 @@ By comparing these DR solutions, you can decide on the final option based on the

* [Backup & restore data](./back-up-&-restore-data.md)
* [DR solution for GreptimeDB Standalone](./dr-solution-for-standalone.md)
* [DR solution based on Active-Active Failover ](/enterprise/administration/disaster-recovery/dr-solution-based-on-active-active-failover.md)
* [DR solution based on Active-Active Failover ](/enterprise/deployments-administration/disaster-recovery/dr-solution-based-on-active-active-failover.md)
* [DR solution based on cross-region deployment in a single cluster](./dr-solution-based-on-cross-region-deployment-in-single-cluster.md)
* [S3 Replicating objects overview](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html)
64 changes: 1 addition & 63 deletions docs/user-guide/protocols/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,70 +71,8 @@ http://localhost:4000/v1/sql
These endpoint cannot be used in GreptimeCloud.
:::

### Check database health
Please refer to the [Admin APIs](/reference/http-endpoints.md#admin-apis) documentation for more information.

You can use the `/health` endpoint to check the health of the GreptimeDB server.
For more information,
please refer to [Check Database Health](/getting-started/installation/overview.md#check-database-health).

### Check Database Status

You can use the `/status` endpoint to check the status of the GreptimeDB server.

```shell
curl http://{{API-host}}/status
```

For example:

```shell
curl http://localhost:4000/status
```

The output contains the database version and source code information,
which will be similar to the following:

```json
{
"source_time": "2024-11-08T06:34:49Z",
"commit": "0e0c4faf0d784f25fed8f26e7000f1f869c88587",
"branch": "main",
"rustc_version": "rustc 1.84.0-nightly (e92993dbb 2024-10-18)",
"hostname": "local",
"version": "0.9.5"
}
```

### Get GreptimeDB server configuration

You can use the `/config` endpoint to get the [TOML configuration](/user-guide/deployments-administration/configuration.md#configuration-file-options) of the GreptimeDB server.

```shell
curl http://{{API-host}}/config
```

For example:

```shell
curl http://localhost:4000/config
```

The output contains the configuration information of the GreptimeDB server.

```toml
enable_telemetry = true
user_provider = "static_user_provider:file:user"
init_regions_in_background = false
init_regions_parallelism = 16

[http]
addr = "127.0.0.1:4000"
timeout = "30s"
body_limit = "64MiB"
is_strict_mode = false

# ...
```

## POST SQL statements

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
keywords: [Kubernetes 部署, Operator 模式, 自动化管理, 集群部署, 单机实例, 私有云, 公有云]
description: 在 Kubernetes 上部署 GreptimeDB 的概述,包括集群的安装、升级和监控等内容。
---

# 在 Kubernetes 上部署 GreptimeDB

GreptimeDB 企业版在 Kubernetes 上的部署流程与开源版基本一致,本章节将重点介绍企业版特有的部署配置和功能。

## 安装

要了解如何通过 Helm Chart 启动 GreptimeDB,请前往[安装 GreptimeDB](./installation.md) 页面。

## 升级

请前往[升级 GreptimeDB](./upgrade.md) 页面了解如何升级 GreptimeDB。


Loading