Skip to content

Commit 3d0285a

Browse files
committed
minor
1 parent 0fcc3d7 commit 3d0285a

File tree

8 files changed

+78
-61
lines changed

8 files changed

+78
-61
lines changed

dir.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@
346346
path: key-value-data-model/redis-compatibility
347347

348348
- title_en: Prometheus
349-
title_cn: Prometheus 兼容
349+
title_cn: Prometheus
350350
collapsed: true
351351
children:
352352
- title_en: Overview

en_US/prometheus/overview.md

Whitespace-only changes.

en_US/prometheus/promql-compatibility.md

Whitespace-only changes.

en_US/prometheus/quick-start.md

Whitespace-only changes.

zh_CN/development-guide/prometheus/overview.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,8 @@
55
Datalayers 兼容 Prometheus 的远程写入协议(Remote Write Protocol) 与 PromQL(Prometheus Query Language)查询语言,支持与 Prometheus 原生生态工具的无缝集成。
66
这意味着您可以:
77

8-
- 继续使用现有的 Prometheus 数据采集配置(如 Prometheus Server、vmagent、Exporter 等),仅需调整数据写入目标,即可将监控数据推送至 Datalayers;
8+
- 继续使用现有的 Prometheus 数据采集配置,仅需调整数据写入目标,即可将监控数据推送至 Datalayers;
99
- 使用 Grafana 等可视化工具直接查询 Datalayers 中的监控数据,无需重写查询语句;
10-
- 在不改变现有监控体系架构的前提下,逐步将 Datalayers 作为 Prometheus 的补充存储层,或直接作为替代方案,以满足更高性能、更大规模、更优成本等需求。
10+
- 在不改变现有监控体系架构的前提下,可将 Datalayers 作为 Prometheus 的补充存储层,或直接作为替代方案,以满足更高性能、更大规模、更优成本等需求。
1111

12-
## 主要优势
13-
14-
- **无缝集成**
15-
支持 Prometheus 原生 Remote Write 协议,无需修改现有采集配置,即可将数据推送至 Datalayers。
16-
- **查询兼容**
17-
全面支持标准的 PromQL(Prometheus Query Language),您可以使用与 Prometheus 完全一致的查询语法,对监控数据进行实时检索、聚合与分析,学习与迁移成本极低。
18-
- **生态兼容**
19-
与 Prometheus 原生生态工具(如 Grafana)天然兼容,无需额外适配或开发,即可快速对接现有监控体系,大幅降低迁移与使用门槛。
20-
- **集群支持**
21-
原生分布式支持,可通过水平扩展实现计算与存储能力的扩展。
22-
- **低存储成本**
23-
Datalayers 支持与主流云厂商的对象存储服务(Object Storage)无缝集成,包括:
24-
- 阿里云 OSS
25-
- 华为云 OBS
26-
- 腾讯云 COS
27-
- AWS S3
28-
- Azure Blob Storage
29-
- Google Cloud Storage (GCS)
30-
31-
同时,对于兼容 S3 协议的第三方对象存储服务(如 MinIO),支持零代码接入,帮助您以极低的成本实现监控数据的长期、安全、高效存储。
12+
详见 [Prometheus 兼容](../../prometheus/overview.md)

zh_CN/prometheus/overview.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
1-
# 概述
1+
# Prometheus 协议兼容
22

3-
Datalayers 支持 Prometheus 的 HTTP API 和 Remote Write 协议。通过这一特性,用户可以将现有的 Prometheus 生态工具无缝接入 Datalayers,无需修改代码即可实现数据写入和查询。
3+
## 概述
44

5-
## 主要特性
5+
Datalayers 兼容 Prometheus 的远程写入协议(Remote Write Protocol) 与 PromQL(Prometheus Query Language)查询语言,支持与 Prometheus 原生生态工具的无缝集成。
6+
这意味着您可以:
67

7-
- 兼容 Prometheus HTTP API,可直接对接 Grafana 等生态组件。
8-
- 兼容 Prometheus Remote Write 协议,可接收 Prometheus 的实时数据推送。
9-
- 支持 PromQL (Prometheus Query Language),兼容主流查询语法与函数
8+
- 继续使用现有的 Prometheus 数据采集配置,仅需调整数据写入目标,即可将数据推送至 Datalayers,实现大规模数据长期低成本存储;
9+
- 使用 Grafana 等可视化工具直接查询 Datalayers 中的监控数据,无需重写查询语句;
10+
- 在不改变现有监控体系架构的前提下,将 Datalayers 作为 Prometheus 的替代方案,以满足高性能、大规模、低存储成本等需求
1011

11-
## 核心价值
12+
## 主要优势
1213

13-
- 平滑迁移: 无需修改现有的数据采集和可视化工具链。
14-
- 高性能/长期存储: 利用 Datalayers 的存储优势,解决原生 Prometheus 在大规模或长期存储场景下的性能和容量瓶颈。
14+
- **无缝集成**
15+
支持 Prometheus 原生 Remote Write 协议,可接收 Prometheus 的实时数据推送。
16+
- **生态兼容**
17+
兼容标准的 PromQL(Prometheus Query Language) 与 HTTP API,可直接对接 Grafana 等生态组件对接。
18+
- **集群支持**
19+
原生分布式支持,可通过水平扩展实现计算与存储能力的扩展。
20+
- **低存储成本**
21+
Datalayers 支持与主流云厂商的对象存储服务(Object Storage)无缝集成,包括:
22+
- 阿里云 OSS
23+
- 华为云 OBS
24+
- 腾讯云 COS
25+
- AWS S3
26+
- Azure Blob Storage
27+
- Google Cloud Storage (GCS)
28+
29+
```text
30+
同时,对于兼容 S3 协议的第三方对象存储服务(如 MinIO),支持零代码接入,帮助您以极低的成本实现监控数据的长期、安全、高效存储。
31+
```
32+
33+
- **高性能/长期存储**:利用 Datalayers 的存储优势,解决原生 Prometheus 在大规模或长期存储场景下的性能和容量瓶颈。

zh_CN/prometheus/promql-compatibility.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# PromQL 兼容性
22

3+
## 概述
4+
5+
Datalayers 提供高度兼容的 PromQL 查询能力,支持绝大多数常用的选择器、运算符和函数,确保从 Prometheus 平滑迁移。
6+
37
## 选择器
48

59
Datalayers 支持 Instant 选择器和 Range 选择器。并且对于普通标签,Datalayers 完整支持四种匹配运算符 (`=, !=, =~, !=`)。
@@ -12,8 +16,8 @@ Datalayers 支持 `offset` 修饰符,但不支持 `@` 修饰符。
1216

1317
| 类型 | 支持 | 不支持 |
1418
| :--- | :--- | :--- |
15-
| **运算符** | `neg`, `add`, `sub`, `mul`, `div`, `mod`, `eq`, `ne`, `gt`, `lt`, `ssgt`, `sslt`, `sseq`, `ssne`, `slt`, `sle`, `sge`, `power`, `atan2`, `and`, `or`, `unless` | |
19+
| **运算符** | `neg`, `add`, `sub`, `mul`, `div`, `mod`, `eq`, `ne`, `gt`, `lt`, `ssgt`, `sslt`, `sseq`, `ssne`, `slt`, `sle`, `sge`, `power`, `atan2`, `and`, `or`, `unless` | - |
1620
| **聚合** | `sum`, `avg`, `min`, `max`, `stddev`, `stdvar`, `topk`, `bottomk`, `count_values`, `count`, `quantile`, `grouping`| `limitk`, `limit_ratio` |
1721
| **Instant 函数** | `abs`, `ceil`, `exp`, `ln`, `log2`, `log10`, `sqrt`, `acos`, `asin`, `atan`, `sin`, `cos`, `tan`, `acosh`, `asinh`, `atanh`, `sinh`, `cosh`, `scalar`, `tanh`, `timestamp`, `sort`, `sort_desc`, `histogram_quantile`, `predict_linear`, `absent`, `sgn`, `pi`, `deg`, `rad`, `floor`, `clamp`, `clamp_max`, `clamp_min` | 其它 `histogram_<aggr>` 函数|
18-
| **Range 函数** | `idelta`, `<aggr>_over_time` (如 `count_over_time`, `stddev_over_time`, `stdvar_over_time`), `changes`, `delta`, `rate`, `deriv`, `increase`, `irate`, `reset` | |
19-
| **其他函数** | `label_join`, `label_replace`, `sort_by_label`, `sort_by_label_desc` | |
22+
| **Range 函数** | `idelta`, `<aggr>_over_time` (如 `count_over_time`, `stddev_over_time`, `stdvar_over_time`), `changes`, `delta`, `rate`, `deriv`, `increase`, `irate`, `reset` | - |
23+
| **其他函数** | `label_join`, `label_replace`, `sort_by_label`, `sort_by_label_desc` | - |

zh_CN/prometheus/quick-start.md

Lines changed: 39 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# 快速开始
22

3-
## Remote Write
3+
Datalayers 完全兼容 Prometheus Remote Write 协议,可无缝承接 Prometheus 数据流。本指南将帮助您快速完成数据接入和查询配置。
4+
5+
## 数据写入配置
6+
7+
### 配置 Prometheus Remote Write
48

59
通过 Prometheus Remote Write 协议,可以将 Prometheus 中的数据快速导入 Datalayers。为此,您需要在 Prometheus 的配置文件中增加以下内容,将 Datalayers 设置为 Remote Write 端点:
610

7-
```
11+
```yaml
812
remote_write:
913
- url: https://<host>:<port>/api/v1/write
1014
basic_auth:
@@ -14,35 +18,50 @@ remote_write:
1418
database: <dbname>
1519
```
1620
17-
其中:
21+
**参数说明**:
22+
23+
- `<host>` 和 `<port>`:Datalayers 服务地址和 HTTP 端口
24+
- `<username>` 和 `<password>`:认证凭据(默认:admin/public)
25+
- `<dbname>`:目标数据库名称(需预先创建)
1826

19-
- `<host>``<port>` 分别表示 Datalayers 的 IP 地址和 HTTP 端口号
20-
- `<dbname>` 表示数据将要导入的数据库名称,该数据库需要预先创建
21-
- `<username>``<password>` 表示用于认证的用户名和密码
27+
### 配置示例
2228

23-
## HTTP API
29+
```yaml
30+
# 实际配置示例
31+
remote_write:
32+
- url: "http://localhost:9090/api/v1/write"
33+
basic_auth:
34+
username: admin
35+
password: public
36+
headers:
37+
database: prometheus_metrics
38+
```
2439

25-
导入 Datalayers 的数据可以通过以下 Prometheus HTTP API 进行查询:
40+
## 数据查询 API
41+
42+
Datalayers 提供完整的 Prometheus HTTP API 兼容接口:
2643

2744
- Instant queries: `/api/v1/query`
2845
- Range queries: `/api/v1/query_range`
2946
- Series: `/api/v1/series`
3047
- Label names: `/api/v1/labels`
3148
- Label values: `/api/v1/label/<label_name>/values`
3249

33-
这些接口的输入和输出与 Prometheus 保持一致,可以作为其直接替换。例如,您可以通过如下请求查询指标 `up``2025-07-22T10:00:00Z` 时刻的数据:
50+
### 查询示例
3451

35-
```
52+
这些接口的输入和输出与 Prometheus 保持一致。例如,您可以通过如下请求查询指标 `up` 在 `2025-07-22T10:00:00Z` 时刻的数据:
53+
54+
```shell
3655
curl -v \
3756
-u admin:public \
3857
-H "database:prom" \
3958
-d "query=up&time=2025-07-22T10:00:00Z" \
4059
"http://localhost:9090/api/v1/query"
4160
```
4261

43-
收到的响应形式如下:
62+
### 响应格式
4463

45-
```
64+
```json
4665
{
4766
"status": "success",
4867
"data": {
@@ -56,27 +75,21 @@ curl -v \
5675
}
5776
```
5877

59-
更多关于 HTTP API 的内容可参考![官方文档](https://prometheus.io/docs/prometheus/latest/querying/api/)
78+
更多关于 API 的内容可参考 [Prometheus 官方文档](https://prometheus.io/docs/prometheus/latest/querying/api/)。
6079

6180
### 注意事项
6281

63-
相较于 Prometheus,Datalayers 有额外的数据库的概念,每个 metric 都归属于某个数据库,因此在查询时需要显式指明数据库的名称。
64-
65-
您可以通过两种方式指定数据库:
82+
相较于 Prometheus,Datalayers 有额外的数据库的概念,每个 metric 都归属于某个数据库,因此在查询时需要显式指明数据库的名称。可通过以下两种方式指定数据库:
6683

6784
1. 在 HTTP 请求的 header 中增加 `database: <dbname>`,之后查询的 metric 都会默认归属该数据库
6885
2. 或者通过标签 `__database__` 指定数据库,如 `up{__database__="dbname"}`。通过这种方式可以覆盖 HTTP header 中指定的数据库。
6986

70-
## Grafana
87+
## Grafana 集成配置
7188

7289
您可以直接将 Datalayers 作为 Prometheus 数据源添加到 Grafana 中,具体步骤如下:
7390

74-
1. 在 Grafana 中 点击 Add new data source,选择 Prometheus 作为数据源
75-
76-
2. 在 Remote server URL 中填入 Datalayers 的地址 `http://<host>:<port>`
77-
78-
3. 在 Authentication method 中选择 Basic authentication,填入用户名和密码
79-
80-
4. 在 Http headers 中增加 header `database: <dbname>`
81-
82-
5. 点击 Save & Test 进行连通性测试,通过后进入面板编写 PromQL 进行查询
91+
- 在 Grafana 中 点击 Add new data source,选择 Prometheus 作为数据源
92+
- 在 Remote server URL 中填入 Datalayers 服务中配置的 Prometheus 协议地址 `http://<host>:<port>`
93+
- 在 Authentication method 中选择 Basic authentication,填入用户名和密码
94+
- 在 Http headers 中增加 header `database: <dbname>`
95+
- 点击 Save & Test 进行连通性测试,通过后进入面板编写 PromQL 进行查询

0 commit comments

Comments
 (0)