Skip to content

Commit b92dc34

Browse files
docs: update remote write special labels (#2297)
Co-authored-by: GitHub Action <action@github.com>
1 parent 48513ee commit b92dc34

File tree

4 files changed

+28
-28
lines changed
  • docs/user-guide/ingest-data/for-observability
  • i18n/zh/docusaurus-plugin-content-docs
  • versioned_docs/version-1.0/user-guide/ingest-data/for-observability

4 files changed

+28
-28
lines changed

docs/user-guide/ingest-data/for-observability/prometheus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -223,17 +223,17 @@ There labels (along with there values) will turn into ingest options during the
223223
The labels are not mutually exclusive, so they can be combined together to produce more versatile controlling.
224224

225225
Here is a representative diagram of special labels for a metric. Note this is not the actual data model of a metric.
226-
| `__name__` | `__database__` | `__physical_table__` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
227-
|------------------|----------------|----------------------|---------------------|-------------------------------------------|-------------------------|---------|
228-
| some_metric_name | public | p_1 | random_k8s_pod_name | true | 2025-06-17 16:31:52.000 | 12.1 |
226+
| `__name__` | `x_greptime_database` | `x_greptime_physical_table` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
227+
|--------------------|-------------------------|-------------------------------|-----------------------|---------------------------------------------|---------------------------|-----------|
228+
| `some_metric_name` | `public` | `p_1` | `random_k8s_pod_name` | `true` | `2025-06-17 16:31:52.000` | `12.1` |
229229

230230
The special labels you see above are just normal valid labels in Prometheus.
231231
GreptimeDB recognizes some of the label names and turns them into ingest options.
232232
It's much like the custom HTTP headers, where you just set a valid HTTP header and its value to indicate following operations, only the header pair means nothing outside your program.
233233

234234
Here is a list of supported label names:
235-
- `__database__`
236-
- `__physical_table__`
235+
- `x_greptime_database`
236+
- `x_greptime_physical_table`
237237

238238
### Setting labels
239239

@@ -243,7 +243,7 @@ If you're using Prometheus to scrape metrics from the source and send them to Gr
243243
Refer to the [docs](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file) here.
244244
It's the same for other collecting tools. You may have to find the relevant configuration for your tool of choice.
245245

246-
### `__database__`
246+
### `x_greptime_database`
247247

248248
This option decides which database the metric goes into. Note, the database should be created in advance(for instance, using `create database xxx` SQL).
249249

@@ -253,7 +253,7 @@ If the metrics are collected and ingested into the same database, then on a Graf
253253

254254
In this case, you might want to store the metrics on different databases during ingestion and use two dashboards to view the metrics separately.
255255

256-
### `__physical_table__`
256+
### `x_greptime_physical_table`
257257

258258
If the metric is storing using the metric engine, then there is a physical table behind each metric's logical table.
259259
By default, all metrics using the same physical table.

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observability/prometheus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -210,17 +210,17 @@ with (
210210
这些标签不是互斥的,它们可以通过组合的方式达成更多样化的控制选择。
211211

212212
以下是指标特殊标签的一个示例,注意这不是实际的数据模型。
213-
| `__name__` | `__database__` | `__physical_table__` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
214-
|------------------|----------------|----------------------|---------------------|-------------------------------------------|-------------------------|---------|
215-
| some_metric_name | public | p_1 | random_k8s_pod_name | true | 2025-06-17 16:31:52.000 | 12.1 |
213+
| `__name__` | `x_greptime_database` | `x_greptime_physical_table` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
214+
|--------------------|-------------------------|-------------------------------|-----------------------|---------------------------------------------|---------------------------|-----------|
215+
| `some_metric_name` | `public` | `p_1` | `random_k8s_pod_name` | `true` | `2025-06-17 16:31:52.000` | `12.1` |
216216

217217
上述特殊标签只是在 Prometheus 中的普通有效标签。
218218
GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的配置项。
219219
就像自定义的 HTTP header 一样,你可以通过设定一些有效的 HTTP header 键值对来指示后续的操作,只是这些 header 键值对在特定的程序之外不起任何作用。
220220

221221
以下是所有 GreptimeDB 支持的标签名称:
222-
- `__database__`
223-
- `__physical_table__`
222+
- `x_greptime_database`
223+
- `x_greptime_physical_table`
224224

225225
### 设置标签
226226

@@ -230,7 +230,7 @@ GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的
230230
参考这个[文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file)
231231
对于其他的收集工具也是一样的。对于你所使用的工具,你可能需要查找相应的设置。
232232

233-
### `__database__`
233+
### `x_greptime_database`
234234

235235
这个选项决定指标数据会被保存到哪个数据库中,该数据库需要被提前创建好(例如通过 `create database xxx` SQL 语句)。
236236

@@ -242,7 +242,7 @@ GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的
242242

243243
在这种情况下,你可以在写入时将指标保存到两个不同的数据库中,然后使用两个大盘分别浏览这些指标。
244244

245-
### `__physical_table__`
245+
### `x_greptime_physical_table`
246246

247247
如果指标通过 metric engine 进行存储,那么每个指标的逻辑表背后是一张物理表。
248248
默认下,所有的指标都使用同一张物理表。

i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/ingest-data/for-observability/prometheus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -210,17 +210,17 @@ with (
210210
这些标签不是互斥的,它们可以通过组合的方式达成更多样化的控制选择。
211211

212212
以下是指标特殊标签的一个示例,注意这不是实际的数据模型。
213-
| `__name__` | `__database__` | `__physical_table__` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
214-
|------------------|----------------|----------------------|---------------------|-------------------------------------------|-------------------------|---------|
215-
| some_metric_name | public | p_1 | random_k8s_pod_name | true | 2025-06-17 16:31:52.000 | 12.1 |
213+
| `__name__` | `x_greptime_database` | `x_greptime_physical_table` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
214+
|--------------------|-------------------------|-------------------------------|-----------------------|---------------------------------------------|---------------------------|-----------|
215+
| `some_metric_name` | `public` | `p_1` | `random_k8s_pod_name` | `true` | `2025-06-17 16:31:52.000` | `12.1` |
216216

217217
上述特殊标签只是在 Prometheus 中的普通有效标签。
218218
GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的配置项。
219219
就像自定义的 HTTP header 一样,你可以通过设定一些有效的 HTTP header 键值对来指示后续的操作,只是这些 header 键值对在特定的程序之外不起任何作用。
220220

221221
以下是所有 GreptimeDB 支持的标签名称:
222-
- `__database__`
223-
- `__physical_table__`
222+
- `x_greptime_database`
223+
- `x_greptime_physical_table`
224224

225225
### 设置标签
226226

@@ -230,7 +230,7 @@ GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的
230230
参考这个[文档](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file)
231231
对于其他的收集工具也是一样的。对于你所使用的工具,你可能需要查找相应的设置。
232232

233-
### `__database__`
233+
### `x_greptime_database`
234234

235235
这个选项决定指标数据会被保存到哪个数据库中,该数据库需要被提前创建好(例如通过 `create database xxx` SQL 语句)。
236236

@@ -242,7 +242,7 @@ GreptimeDB 可以识别一些标签的名称,并将它们转换成写入时的
242242

243243
在这种情况下,你可以在写入时将指标保存到两个不同的数据库中,然后使用两个大盘分别浏览这些指标。
244244

245-
### `__physical_table__`
245+
### `x_greptime_physical_table`
246246

247247
如果指标通过 metric engine 进行存储,那么每个指标的逻辑表背后是一张物理表。
248248
默认下,所有的指标都使用同一张物理表。

versioned_docs/version-1.0/user-guide/ingest-data/for-observability/prometheus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -223,17 +223,17 @@ There labels (along with there values) will turn into ingest options during the
223223
The labels are not mutually exclusive, so they can be combined together to produce more versatile controlling.
224224

225225
Here is a representative diagram of special labels for a metric. Note this is not the actual data model of a metric.
226-
| `__name__` | `__database__` | `__physical_table__` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
227-
|------------------|----------------|----------------------|---------------------|-------------------------------------------|-------------------------|---------|
228-
| some_metric_name | public | p_1 | random_k8s_pod_name | true | 2025-06-17 16:31:52.000 | 12.1 |
226+
| `__name__` | `x_greptime_database` | `x_greptime_physical_table` | `pod_name_label` | `__normal_label_with_underscore_prefix__` | `timestamp` | `value` |
227+
|--------------------|-------------------------|-------------------------------|-----------------------|---------------------------------------------|---------------------------|-----------|
228+
| `some_metric_name` | `public` | `p_1` | `random_k8s_pod_name` | `true` | `2025-06-17 16:31:52.000` | `12.1` |
229229

230230
The special labels you see above are just normal valid labels in Prometheus.
231231
GreptimeDB recognizes some of the label names and turns them into ingest options.
232232
It's much like the custom HTTP headers, where you just set a valid HTTP header and its value to indicate following operations, only the header pair means nothing outside your program.
233233

234234
Here is a list of supported label names:
235-
- `__database__`
236-
- `__physical_table__`
235+
- `x_greptime_database`
236+
- `x_greptime_physical_table`
237237

238238
### Setting labels
239239

@@ -243,7 +243,7 @@ If you're using Prometheus to scrape metrics from the source and send them to Gr
243243
Refer to the [docs](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file) here.
244244
It's the same for other collecting tools. You may have to find the relevant configuration for your tool of choice.
245245

246-
### `__database__`
246+
### `x_greptime_database`
247247

248248
This option decides which database the metric goes into. Note, the database should be created in advance(for instance, using `create database xxx` SQL).
249249

@@ -253,7 +253,7 @@ If the metrics are collected and ingested into the same database, then on a Graf
253253

254254
In this case, you might want to store the metrics on different databases during ingestion and use two dashboards to view the metrics separately.
255255

256-
### `__physical_table__`
256+
### `x_greptime_physical_table`
257257

258258
If the metric is storing using the metric engine, then there is a physical table behind each metric's logical table.
259259
By default, all metrics using the same physical table.

0 commit comments

Comments
 (0)