Skip to content

Commit

Permalink
fix: typo (#1486)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicecui authored Jan 22, 2025
1 parent b1be224 commit 29b6c16
Show file tree
Hide file tree
Showing 146 changed files with 271 additions and 149 deletions.
4 changes: 3 additions & 1 deletion .github/scripts/check-front-matter.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ const github = require('@actions/github');
// Add the special files here, for example, the template files
const exceptionFiles = [
'docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md',
'docs/db-cloud-shared/migrate/_migrate-from-prometheus.md',
'i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md',
'i18n/zh/docusaurus-plugin-content-docs/version-0.11/user-guide/ingest-data/for-iot/grpc-sdks/template.md'
'i18n/zh/docusaurus-plugin-content-docs/version-0.11/user-guide/ingest-data/for-iot/grpc-sdks/template.md',
'i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/migrate/_migrate-from-prometheus.md'
];

// This function checks if a markdown file contains the required front matter.
Expand Down
2 changes: 1 addition & 1 deletion docs/db-cloud-shared/migrate/_migrate-from-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This allows for an easy migration of your Prometheus long-term storage to Grepti

## Data model in difference

To understand the differences between the data models of Prometheus and GreptimeDB, please refer to the [Data Model](/user-guide/ingest-data/for-observerbility/prometheus.md#data-model) in the Ingest Data documentation.
To understand the differences between the data models of Prometheus and GreptimeDB, please refer to the [Data Model](/user-guide/ingest-data/for-observability/prometheus.md#data-model) in the Ingest Data documentation.

## Prometheus Remote Write

Expand Down
2 changes: 1 addition & 1 deletion docs/enterprise/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ GreptimeDB Enterprise solutions include:
- **Bring Your Own Cloud (BYOC)**: Leverage your own cloud infrastructure to host GreptimeDB, offering extensive customization and flexibility tailored to your business needs. This service includes comprehensive management of your cloud resources and robust security measures to protect your infrastructure.
- **Fully Managed Dedicated Cloud**: GreptimeDB team offers a fully managed, dedicated cloud environment, ensuring peak performance, enhanced security, and exceptional reliability tailored to your enterprise needs.
- **[Edge-Cloud Integrated Solution](https://greptime.com/product/carcloud)**: A comprehensive solution for managing time-series data from edge devices to the cloud, enabling real-time analytics and insights across your entire infrastructure.
- Industry-specific solutions for the Internet of Things (IoT), observerbility, and more.
- Industry-specific solutions for the Internet of Things (IoT), observability, and more.


This section provides an overview of the advanced features available in GreptimeDB Enterprise. For information on obtaining trial access or purchasing licenses, please [contact us](https://greptime.com/contactus).
Expand Down
6 changes: 3 additions & 3 deletions docs/faq-and-others/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ We plan to further refine the log engine, focusing on improving query performanc

For more information about using GreptimeDB with logs, refer to the documentation:
- [Log Overview](/user-guide/logs/overview.md)
- [OpenTelemetry compatibility](/user-guide/ingest-data/for-observerbility/opentelemetry.md)
- [Loki protocol compatibility](/user-guide/ingest-data/for-observerbility/opentelemetry.md)
- [Vector compatibility](/user-guide/ingest-data/for-observerbility/vector.md)
- [OpenTelemetry compatibility](/user-guide/ingest-data/for-observability/opentelemetry.md)
- [Loki protocol compatibility](/user-guide/ingest-data/for-observability/opentelemetry.md)
- [Vector compatibility](/user-guide/ingest-data/for-observability/vector.md)

### What would be the use cases for a time-series database?

Expand Down
2 changes: 1 addition & 1 deletion docs/greptimecloud/integrations/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ tls = {}

## Reference

For detailed information on the data ingestion process, please refer to the [Ingest Data via Kafka](https://docs.greptime.com/nightly/user-guide/ingest-data/for-observerbility/kafka) guide.
For detailed information on the data ingestion process, please refer to the [Ingest Data via Kafka](https://docs.greptime.com/nightly/user-guide/ingest-data/for-observability/kafka) guide.

Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ write_interval = "30s"
url = "http://127.0.0.1:4000/v1/prometheus/write?db=system"
```

GreptimeDB is compatible with the Prometheus Remote-Write protocol. For more information, please refer to the [Prometheus Remote-Write](/user-guide/ingest-data/for-observerbility/prometheus.md) documentation.
GreptimeDB is compatible with the Prometheus Remote-Write protocol. For more information, please refer to the [Prometheus Remote-Write](/user-guide/ingest-data/for-observability/prometheus.md) documentation.

## Metrics Detail
You can check the output of `curl http://<host>:<port>/metrics` by getting the latest metrics of GreptimeDB. We will add more documents of the metrics sooner.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/ingest-data/for-iot/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Write data from Kafka to GreptimeDB.

# Kafka

Please refer to the [Kafka documentation](/user-guide/ingest-data/for-observerbility/kafka.md) for instructions on how to ingest data from Kafka into GreptimeDB.
Please refer to the [Kafka documentation](/user-guide/ingest-data/for-observability/kafka.md) for instructions on how to ingest data from Kafka into GreptimeDB.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ prometheus.remote_write "greptimedb" {
- `GREPTIME_DB`: GreptimeDB database name, default is `public`.
- `GREPTIME_USERNAME` and `GREPTIME_PASSWORD`: The [authentication credentials](/user-guide/deployments/authentication/static.md) for GreptimeDB.

For details on the data model transformation from Prometheus to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observerbility/prometheus.md#data-model) section in the Prometheus Remote Write guide.
For details on the data model transformation from Prometheus to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observability/prometheus.md#data-model) section in the Prometheus Remote Write guide.

## OpenTelemetry

Expand Down Expand Up @@ -58,7 +58,7 @@ otelcol.auth.basic "credentials" {
- `GREPTIME_DB`: GreptimeDB database name, default is `public`.
- `GREPTIME_USERNAME` and `GREPTIME_PASSWORD`: The [authentication credentials](/user-guide/deployments/authentication/static.md) for GreptimeDB.

For details on the metrics data model transformation from OpenTelemetry to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observerbility/opentelemetry.md#data-model) section in the OpenTelemetry guide.
For details on the metrics data model transformation from OpenTelemetry to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observability/opentelemetry.md#data-model) section in the OpenTelemetry guide.

### Logs

Expand Down Expand Up @@ -110,7 +110,7 @@ otelcol.exporter.otlphttp "greptimedb_logs" {
- `LOG_TABLE_NAME`: The name of the table to store logs, default table name is `opentelemetry_logs`.
- `EXTRACT_KEYS`: The keys to extract from the attributes, separated by commas (`,`), e.g., `filename,log.file.name,loki.attribute.labels`, see [HTTP API documentation](opentelemetry.md#otlphttp-api-1) for details.

For details on the log data model transformation from OpenTelemetry to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observerbility/opentelemetry.md#data-model-1) section in the OpenTelemetry guide.
For details on the log data model transformation from OpenTelemetry to GreptimeDB, refer to the [Data Model](/user-guide/ingest-data/for-observability/opentelemetry.md#data-model-1) section in the OpenTelemetry guide.

:::tip NOTE
The example codes above may be outdated according to OpenTelemetry. We recommend that you refer to the official OpenTelemetry documentation And Grafana Alloy for the most up-to-date information.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [InfluxDB Line Protocol]
description: Write data to GreptimeDB using the InfluxDB Line Protocol
---

# InfluxDB Line Protocol

Please refer to the [InfluxDB Line Protocol documentation](../for-iot/influxdb-line-protocol.md) for instructions on how to write data to GreptimeDB using the InfluxDB Line Protocol.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ The following rules are used when storing Vector metrics into GreptimeDB:

## Collect metrics with InfluxDB line protocol format

Vector can collect metrics in the InfluxDB line protocol format and send them to GreptimeDB. For more information, refer to the [Kafka guide](/user-guide/ingest-data/for-observerbility/kafka.md#metrics).
Vector can collect metrics in the InfluxDB line protocol format and send them to GreptimeDB. For more information, refer to the [Kafka guide](/user-guide/ingest-data/for-observability/kafka.md#metrics).

## Collect logs

Vector can also collect logs and send them to GreptimeDB. For more details, refer to the [Kafka guide](/user-guide/ingest-data/for-observerbility/kafka.md#logs).
Vector can also collect logs and send them to GreptimeDB. For more details, refer to the [Kafka guide](/user-guide/ingest-data/for-observability/kafka.md#logs).

2 changes: 1 addition & 1 deletion docs/user-guide/ingest-data/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This feature is supported for all protocols and integrations, except [SQL](./for

GreptimeDB supports various data ingestion methods for specific scenarios, ensuring optimal performance and integration flexibility.

- [For Observability Scenarios](./for-observerbility/overview.md): Suitable for real-time monitoring and alerting.
- [For Observability Scenarios](./for-observability/overview.md): Suitable for real-time monitoring and alerting.
- [For IoT Scenarios](./for-iot/overview.md): Suitable for real-time data and complex IoT infrastructures.

## Next Steps
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/integrations/alloy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ description: Integrate GreptimeDB with Grafana Alloy.
# Grafana Alloy

GreptimeDB can be set up as a data sink for Grafana Alloy.
For more information, please refer to the [Ingest Data through Grafana Alloy](/user-guide/ingest-data/for-observerbility/alloy.md) guide.
For more information, please refer to the [Ingest Data through Grafana Alloy](/user-guide/ingest-data/for-observability/alloy.md) guide.

2 changes: 1 addition & 1 deletion docs/user-guide/integrations/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ description: Learn how to ingest observability data from Kafka into GreptimeDB u
# Kafka

Vector can be used as a tool to transport data from Kafka to GreptimeDB.
For more information, please refer to the [Ingest Data via Kafka](/user-guide/ingest-data/for-observerbility/kafka.md) guide.
For more information, please refer to the [Ingest Data via Kafka](/user-guide/ingest-data/for-observability/kafka.md) guide.

2 changes: 1 addition & 1 deletion docs/user-guide/integrations/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Describes how to use GreptimeDB as a remote storage backend for Pro

GreptimeDB can be used as a remote storage backend for Prometheus.
For detailed information,
please refer to the [Ingest Data with Prometheus Remote Write](/user-guide/ingest-data/for-observerbility/prometheus.md) document.
please refer to the [Ingest Data with Prometheus Remote Write](/user-guide/ingest-data/for-observability/prometheus.md) document.

## Prometheus Query Language (PromQL)

Expand Down
7 changes: 6 additions & 1 deletion docs/user-guide/integrations/vector.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
keywords: [Vector, Vector sink]
description: Guide on using Vector to sink data to GreptimeDB.
---

# Vector

Please refer to the [Ingest Data with Vector](/user-guide/ingest-data/for-observerbility/vector.md) document for instructions on how to sink data to GreptimeDB using Vector.
Please refer to the [Ingest Data with Vector](/user-guide/ingest-data/for-observability/vector.md) document for instructions on how to sink data to GreptimeDB using Vector.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import DocTemplate from '../../db-cloud-shared/migrate/_migrate-from-prometheus.

<div id="remote-write">

For information on configuring Prometheus to write data to GreptimeDB, please refer to the [remote write](/user-guide/ingest-data/for-observerbility/prometheus.md#remote-write-configuration) documentation.
For information on configuring Prometheus to write data to GreptimeDB, please refer to the [remote write](/user-guide/ingest-data/for-observability/prometheus.md#remote-write-configuration) documentation.

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/protocols/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Use Elasticsearch protocol to ingest log data.

# Elasticsearch

Please refer to [Ingest Data with Elasticsearch](/user-guide/ingest-data/for-observerbility/elasticsearch.md) for detailed information.
Please refer to [Ingest Data with Elasticsearch](/user-guide/ingest-data/for-observability/elasticsearch.md) for detailed information.
2 changes: 1 addition & 1 deletion docs/user-guide/protocols/loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Learn how to ingest data with Loki.

# Loki

Please refer to [Ingest Data with Loki](/user-guide/ingest-data/for-observerbility/loki.md) for detailed information.
Please refer to [Ingest Data with Loki](/user-guide/ingest-data/for-observability/loki.md) for detailed information.
7 changes: 6 additions & 1 deletion docs/user-guide/protocols/opentelemetry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
keywords: [OpenTelemetry, OTLP]
description: Consume OpenTelemetry Metrics natively via OTLP/HTTP protocol
---

# OpenTelemetry (OTLP)

GreptimeDB is an observability backend to consume OpenTelemetry Metrics natively via [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) protocol.
Please refer to the [Ingest Data with OpenTelemetry](/user-guide/ingest-data/for-observerbility/opentelemetry.md) document for detailed information.
Please refer to the [Ingest Data with OpenTelemetry](/user-guide/ingest-data/for-observability/opentelemetry.md) document for detailed information.
4 changes: 2 additions & 2 deletions i18n/zh/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@
"message": "写入数据",
"description": "The label for category Ingest Data in sidebar docs"
},
"sidebar.docs.category.For Observerbility": {
"sidebar.docs.category.For observability": {
"message": "可观测场景",
"description": "The label for category For Observerbility in sidebar docs"
"description": "The label for category For observability in sidebar docs"
},
"sidebar.docs.category.For IoT": {
"message": "物联网(IoT)场景",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GreptimeDB 可以用来存储 [Prometheus](https://prometheus.io/) 的时间序

## 数据模型的区别

要了解 Prometheus 和 GreptimeDB 数据模型之间的差异,请参阅 Ingest Data 文档中的[数据模型](/user-guide/ingest-data/for-observerbility/prometheus.md#data-model)部分。
要了解 Prometheus 和 GreptimeDB 数据模型之间的差异,请参阅 Ingest Data 文档中的[数据模型](/user-guide/ingest-data/for-observability/prometheus.md#data-model)部分。

## Prometheus Remote Write

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ tls = {}

## 参考文档

请参考[通过 Kafka 写入数据](https://docs.greptime.cn/nightly/user-guide/ingest-data/for-observerbility/kafka)获取数据写入过程的详细信息。
请参考[通过 Kafka 写入数据](https://docs.greptime.cn/nightly/user-guide/ingest-data/for-observability/kafka)获取数据写入过程的详细信息。

Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ url = "http://127.0.0.1:4000/v1/prometheus/write?db=system"
```

GreptimeDB 兼容 Prometheus Remote-Write 协议。
请参考 [Prometheus Remote-Write](/user-guide/ingest-data/for-observerbility/prometheus.md) 获取更多信息。
请参考 [Prometheus Remote-Write](/user-guide/ingest-data/for-observability/prometheus.md) 获取更多信息。

## 指标详情

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ description: 将数据从 Kafka 写入到 GreptimeDB.

# Kafka

请参考 [Kafka 文档](/user-guide/ingest-data/for-observerbility/kafka.md)了解如何将数据从 Kafka 写入到 GreptimeDB。
请参考 [Kafka 文档](/user-guide/ingest-data/for-observability/kafka.md)了解如何将数据从 Kafka 写入到 GreptimeDB。

Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ prometheus.remote_write "greptimedb" {
- `GREPTIME_DB`: GreptimeDB 数据库名称,默认是 `public`
- `GREPTIME_USERNAME``GREPTIME_PASSWORD`: GreptimeDB的[鉴权认证信息](/user-guide/deployments/authentication/static.md)

有关从 Prometheus 到 GreptimeDB 的数据模型转换的详细信息,请参阅 Prometheus Remote Write 指南中的[数据模型](/user-guide/ingest-data/for-observerbility/prometheus.md#数据模型)部分。
有关从 Prometheus 到 GreptimeDB 的数据模型转换的详细信息,请参阅 Prometheus Remote Write 指南中的[数据模型](/user-guide/ingest-data/for-observability/prometheus.md#数据模型)部分。

## OpenTelemetry

Expand Down Expand Up @@ -58,7 +58,7 @@ otelcol.auth.basic "credentials" {
- `GREPTIME_DB`: GreptimeDB 数据库名称,默认是 `public`
- `GREPTIME_USERNAME``GREPTIME_PASSWORD`: GreptimeDB 的[鉴权认证信息](/user-guide/deployments/authentication/static.md)

有关从 OpenTelemetry 到 GreptimeDB 的指标数据模型转换的详细信息,请参阅 OpenTelemetry 指南中的[数据模型](/user-guide/ingest-data/for-observerbility/opentelemetry.md#数据模型)部分。
有关从 OpenTelemetry 到 GreptimeDB 的指标数据模型转换的详细信息,请参阅 OpenTelemetry 指南中的[数据模型](/user-guide/ingest-data/for-observability/opentelemetry.md#数据模型)部分。

### 日志

Expand Down Expand Up @@ -110,7 +110,7 @@ otelcol.exporter.otlphttp "greptimedb_logs" {
- `LOG_TABLE_NAME`: 存储日志的表名,默认表名为 `opentelemetry_logs`
- `EXTRACT_KEYS`: 从属性中提取对应 key 的值到表的顶级字段,用逗号分隔,例如 `filename,log.file.name,loki.attribute.labels`,详情请看 [HTTP API 文档](opentelemetry.md#otlphttp-api-1)

有关从 OpenTelemetry 到 GreptimeDB 的日志数据模型转换的详细信息,请参阅 OpenTelemetry 指南中的[数据模型](/user-guide/ingest-data/for-observerbility/opentelemetry.md#数据模型-1)部分。
有关从 OpenTelemetry 到 GreptimeDB 的日志数据模型转换的详细信息,请参阅 OpenTelemetry 指南中的[数据模型](/user-guide/ingest-data/for-observability/opentelemetry.md#数据模型-1)部分。

:::tip 提示
上述示例代码可能会过时,请参考 OpenTelemetry 和 Grafana Alloy 的官方文档以获取最新信息。
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
keywords: [InfluxDB Line Protocol]
description: 使用 InfluxDB Line Protocol 将数据写入到 GreptimeDB
---

# InfluxDB Line Protocol


请参考 [InfluxDB Line Protocol 文档](../for-iot/influxdb-line-protocol.md) 了解如何使用 InfluxDB Line Protocol 将数据写入到 GreptimeDB。


Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ vector -c sample.toml

## 收集 InfluxDB 行协议格式的指标

Vector 可以收集 InfluxDB 行协议格式的指标并将其发送到 GreptimeDB。更多信息请参考 [Kafka 指南](/user-guide/ingest-data/for-observerbility/kafka.md#指标)
Vector 可以收集 InfluxDB 行协议格式的指标并将其发送到 GreptimeDB。更多信息请参考 [Kafka 指南](/user-guide/ingest-data/for-observability/kafka.md#指标)


## 收集日志

Vector 可以收集日志并发送到 GreptimeDB。更多信息请参考 [Kafka 指南](/user-guide/ingest-data/for-observerbility/kafka.md#日志)
Vector 可以收集日志并发送到 GreptimeDB。更多信息请参考 [Kafka 指南](/user-guide/ingest-data/for-observability/kafka.md#日志)

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ GreptimeDB 支持无 schema 写入,即在数据写入时自动创建表格并

GreptimeDB 支持针对特定场景的各种数据写入方法,以确保最佳性能和集成灵活性。

- [可观测场景](./for-observerbility/overview.md):适用于实时监控和警报。
- [可观测场景](./for-observability/overview.md):适用于实时监控和警报。
- [物联网场景](./for-iot/overview.md):适用于实时数据和复杂的物联网基础设施。

## 下一步
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ description: 将 GreptimeDB 与 Grafana Alloy 集成。
# Grafana Alloy

你可以将 GreptimeDB 设置为 Grafana Alloy 的数据接收端。
更多信息,请参考[通过 Grafana Alloy 写入数据](/user-guide/ingest-data/for-observerbility/alloy.md)指南。
更多信息,请参考[通过 Grafana Alloy 写入数据](/user-guide/ingest-data/for-observability/alloy.md)指南。
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ description: 从 Kafka 写入数据到 GreptimeDB。
# Kafka

你可以使用 Vector 作为从 Kafka 到 GreptimeDB 的数据传输工具。
请前往[通过 Kafka 写入数据](/user-guide/ingest-data/for-observerbility/kafka.md)了解更多信息。
请前往[通过 Kafka 写入数据](/user-guide/ingest-data/for-observability/kafka.md)了解更多信息。
Loading

0 comments on commit 29b6c16

Please sign in to comment.