docs: add doc for opentelemetry logs

docs/db-cloud-shared/clients/otlp-logs-integration.md

@@ -0,0 +1,22 @@
+GreptimeDB is an observability backend to consume OpenTelemetry Logs natively via [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) protocol.
+
+#### API
+
+To send OpenTelemetry Logs to GreptimeDB through OpenTelemetry SDK libraries, use the following information:
+
+* URL: `https://<host>/v1/otlp/v1/logs`
+* Headers:
+  * `X-Greptime-DB-Name`: `<dbname>`
+  * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `<username>:<password>`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication/static/) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication).
+  * `X-Greptime-Log-Table-Name`: `<table_name>` (optional) - The table name to store the logs. If not provided, the default table name is `opentelemetry_logs`.
+  * `X-Greptime-Log-Extract-Keys`: `<extract_keys>` (optional) - The keys to extract from the attributes. The keys should be separated by commas (`,`). For example, `key1,key2,key3` will extract the keys `key1`, `key2`, and `key3` from the attributes and promote them to the top level of the log, setting them as tags. If the field type is array, float, or object, an error will be returned. If a pipeline is provided, this setting will be ignored.
+  * `X-Greptime-Log-Pipeline-Name`: `<pipeline_name>` (optional) - The pipeline name to process the logs. If not provided, the extract keys will be used to process the logs.
+  * `X-Greptime-Log-Pipeline-Version`: `<pipeline_version>` (optional) - The pipeline version to process the logs. If not provided, the latest version of the pipeline will be used.
+
+The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`.
+
+:::tip NOTE
+The package names may change according to OpenTelemetry, so we recommend that you refer to the official OpenTelemetry documentation for the most up-to-date information.
+:::
+
+For more information about the OpenTelemetry SDK, please refer to the official documentation for your preferred programming language.

docs/db-cloud-shared/clients/otlp-integration.md → docs/db-cloud-shared/clients/otlp-metrics-integration.md

@@ -1,13 +1,13 @@
 GreptimeDB is an observability backend to consume OpenTelemetry Metrics natively via [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) protocol.
 
-### API
+#### API
 
 To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, use the following information:
 
 * URL: `https://<host>/v1/otlp/v1/metrics`
 * Headers:
   * `X-Greptime-DB-Name`: `<dbname>`
-  * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `<username>:<password>`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication)
+  * `Authorization`: `Basic` authentication, which is a Base64 encoded string of `<username>:<password>`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/deployments/authentication/static/) and [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication)
 
 The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/).
 

docs/user-guide/ingest-data/for-observerbility/opentelemetry.md

@@ -2,13 +2,15 @@
 
 [OpenTelemetry](https://opentelemetry.io/) is a vendor-neutral open-source observability framework for instrumenting, generating, collecting, and exporting telemetry data such as traces, metrics, logs. The OpenTelemetry Protocol (OTLP) defines the encoding, transport, and delivery mechanism of telemetry data between telemetry sources, intermediate processes such as collectors and telemetry backends.
 
-## OTLP/HTTP
+## Metrics
 
-import Includeotlpintegration from '../../../db-cloud-shared/clients/otlp-integration.md' 
+### OTLP/HTTP
 
-<Includeotlpintegration/>
+import Includeotlpmetrycsintegration from '../../../db-cloud-shared/clients/otlp-metrics-integration.md' 
 
-### Example Code
+<Includeotlpmetrycsintegration/>
+
+#### Example Code
 
 Here are some example codes about how to setup the request in different languages:
 
@@ -88,7 +90,7 @@ The example codes above may be outdated according to OpenTelemetry. We recommend
 
 For more information on the example code, please refer to the official documentation for your preferred programming language.
 
-## Data Model
+#### Data Model
 
 The OTLP metrics data model is mapped to the GreptimeDB data model according to the following rules:
 
@@ -98,3 +100,87 @@ The OTLP metrics data model is mapped to the GreptimeDB data model according to
 - The data of Gauge/Sum data types will be used as the field column of GreptimeDB, and the column name is `greptime_value`.
 - Each quantile of the Summary data type will be used as a separated data column of GreptimeDB, and the column name is `greptime_pxx`, where xx is the quantile, such as 90/99, etc.
 - Histogram and ExponentialHistogram are not supported yet, we may introduce the Histogram data type to natively support these two types in a later version.
+
+## Logs
+
+### OTLP/HTTP
+
+import Includeotlplogintegration from '../../../db-cloud-shared/clients/otlp-logs-integration.md' 
+
+<Includeotlplogintegration/>
+
+#### Example Code
+
+Here are some example codes about how to use Grafana Alloy to send OpenTelemetry logs to GreptimeDB:
+
+```hcl
+loki.source.file "greptime" {
+  targets = [
+    {__path__ = "/tmp/foo.txt"},
+  ]
+  forward_to = [otelcol.receiver.loki.greptime.receiver]
+}
+
+otelcol.receiver.loki "greptime" {
+  output {
+    logs = [otelcol.exporter.otlphttp.greptimedb_logs.input]
+  }
+}
+
+otelcol.auth.basic "credentials" {
+  username = "${GREPTIME_USERNAME}"
+  password = "${GREPTIME_PASSWORD}"
+}
+
+otelcol.exporter.otlphttp "greptimedb_logs" {
+  client {
+    endpoint = "${GREPTIME_SCHEME:=http}://${GREPTIME_HOST:=greptimedb}:${GREPTIME_PORT:=4000}/v1/otlp/"
+    headers  = {
+      "X-Greptime-DB-Name" = "${GREPTIME_DB:=public}",
+      "x-greptime-log-table-name" = "demo_logs",
+      "x-greptime-log-extract-keys" = "filename,log.file.name,loki.attribute.labels",
+    }
+    auth     = otelcol.auth.basic.credentials.handler
+  }
+}
+```
+
+This example listens for changes to the file and sends the latest values to GreptimeDB via the otlp protocol.
+
+:::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.
+:::
+
+For more information on the example code, please refer to the official documentation for your preferred programming language.
+
+#### Data Model
+
+The OTLP logs data model is mapped to the GreptimeDB data model according to the following rules:
+
+Default table schema:
+
+```sql
++-----------------------+---------------------+------+------+---------+---------------+
+| Column                | Type                | Key  | Null | Default | Semantic Type |
++-----------------------+---------------------+------+------+---------+---------------+
+| timestamp             | TimestampNanosecond | PRI  | NO   |         | TIMESTAMP     |
+| trace_id              | String              |      | YES  |         | FIELD         |
+| span_id               | String              |      | YES  |         | FIELD         |
+| severity_text         | String              |      | YES  |         | FIELD         |
+| severity_number       | Int32               |      | YES  |         | FIELD         |
+| body                  | String              |      | YES  |         | FIELD         |
+| log_attributes        | Json                |      | YES  |         | FIELD         |
+| trace_flags           | UInt32              |      | YES  |         | FIELD         |
+| scope_name            | String              | PRI  | YES  |         | TAG           |
+| scope_version         | String              |      | YES  |         | FIELD         |
+| scope_attributes      | Json                |      | YES  |         | FIELD         |
+| scope_schema_url      | String              |      | YES  |         | FIELD         |
+| resource_attributes   | Json                |      | YES  |         | FIELD         |
+| resource_schema_url   | String              |      | YES  |         | FIELD         |
++-----------------------+---------------------+------+------+---------+---------------+
+17 rows in set (0.00 sec)
+```
+
+- You can use `X-Greptime-Log-Table-Name` to specify the table name for storing the logs. If not provided, the default table name is `opentelemetry_logs`.
+- All attributes, including resource attributes, scope attributes, and log attributes, will be stored as a JSON column in the GreptimeDB table.
+- The timestamp of the log will be used as the timestamp index in GreptimeDB, with the column name `timestamp`. It is preferred to use `time_unix_nano` as the timestamp column. If `time_unix_nano` is not provided, `observed_time_unix_nano` will be used instead.

i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-logs-integration.md

@@ -0,0 +1,22 @@
+GreptimeDB 是一个可观测性后端，能够通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生地消费 OpenTelemetry 日志。
+
+#### API
+
+要通过 OpenTelemetry SDK 库将 OpenTelemetry 日志发送到 GreptimeDB，请使用以下信息：
+
+* **URL:** `https://<host>/v1/otlp/v1/logs`
+* **Headers:**
+  * `X-Greptime-DB-Name`: `<dbname>`
+  * `Authorization`: `Basic` 认证，这是一个 Base64 编码的 `<username>:<password>` 字符串。更多信息，请参考 [鉴权](https://docs.greptime.com/zh/user-guide/deployments/authentication/static/) 和 [HTTP API](https://docs.greptime.com/user-guide/protocols/http#authentication)。
+  * `X-Greptime-Log-Table-Name`: `<table_name>`（可选）- 存储日志的表名。如果未提供，默认表名为 `opentelemetry_logs`。
+  * `X-Greptime-Log-Extract-Keys`: `<extract_keys>`（可选）- 从属性中提取对应 key 的值到表的顶级字段。key 应以逗号（`,`）分隔。例如，`key1,key2,key3` 将从属性中提取 `key1`、`key2` 和 `key3`，并将它们提升到日志的顶层，设置为标签。如果提取的字段类型是数组、浮点数或对象，将返回错误。如果提供了 pipeline name，此设置将被忽略。
+  * `X-Greptime-Log-Pipeline-Name`: `<pipeline_name>`（可选）- 处理日志的 pipeline 名称。如果未提供，将使用 `X-Greptime-Log-Extract-Keys` 来处理日志。
+  * `X-Greptime-Log-Pipeline-Version`: `<pipeline_version>`（可选）- 处理日志的 pipeline 的版本。如果未提供，将使用 pipeline 的最新版本。
+
+请求使用二进制 protobuf 编码负载，因此您需要使用支持 `HTTP/protobuf` 的包。
+
+:::tip 提示
+包名可能会根据 OpenTelemetry 的更新而变化，因此我们建议您参考官方 OpenTelemetry 文档以获取最新信息。
+:::
+
+有关 OpenTelemetry SDK 的更多信息，请参考您首选编程语言的官方文档。

i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-integration.md → i18n/zh/docusaurus-plugin-content-docs/current/db-cloud-shared/clients/otlp-metrics-integration.md

@@ -7,7 +7,7 @@ GreptimeDB 通过原生支持 [OTLP/HTTP](https://opentelemetry.io/docs/specs/ot
 * URL: `https://<host>/v1/otlp/v1/metrics`
 * Headers:
   * `X-Greptime-DB-Name`: `<dbname>`
-* `Authorization`: `Basic` 认证，是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.cn/user-guide/deployments/authentication) 和 [HTTP API](https://docs.greptime.cn/user-guide/protocols/http#authentication)。
+* `Authorization`: `Basic` 认证，是 `<username>:<password>` 的 Base64 编码字符串。更多信息请参考 [鉴权](https://docs.greptime.com/zh/user-guide/deployments/authentication/static/) 和 [HTTP API](https://docs.greptime.cn/user-guide/protocols/http#authentication)。
 
 请求中使用 binary protobuf 编码 payload，因此你需要使用支持 `HTTP/protobuf` 的包。例如，在 Node.js 中，可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto)；在 Go 中，可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)；在 Java 中，可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp)；在 Python 中，可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)。
 

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

@@ -2,14 +2,15 @@
 
 [OpenTelemetry](https://opentelemetry.io/) 是一个供应商中立的开源可观测性框架，用于检测、生成、收集和导出观测数据，例如 traces, metrics 和 logs。
 OpenTelemetry Protocol (OTLP) 定义了观测数据在观测源和中间进程（例如收集器和观测后端）之间的编码、传输机制。
+## Metrics
 
-## OTLP/HTTP
+### OTLP/HTTP
 
-import Includeotlpintegration from '../../../db-cloud-shared/clients/otlp-integration.md' 
+import Includeotlpmetrycsintegration from '../../../db-cloud-shared/clients/otlp-metrics-integration.md' 
 
-<Includeotlpintegration/>
+<Includeotlpmetrycsintegration/>
 
-### 示例代码
+#### 示例代码
 
 下面是一些编程语言设置请求的示例代码：
 
@@ -89,7 +90,7 @@ exporter = OTLPMetricExporter(
 
 关于示例代码，请参考 Opentelementry 的官方文档获取它所支持的编程语言获取更多信息。
 
-## 数据模型
+#### 数据模型
 
 OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型中：
 
@@ -100,3 +101,86 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型
 - Summary 类型的每个 quantile 被作为单独的数据列，列名 `greptime_pxx`，其中 xx 是 quantile 的数据，如  90 / 99 等。
 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。
 
+## Logs
+
+### OTLP/HTTP
+
+import Includeotlplogintegration from '../../../db-cloud-shared/clients/otlp-logs-integration.md' 
+
+<Includeotlplogintegration/>
+
+#### 示例代码
+
+以下是一些关于如何使用 Grafana Alloy 将 OpenTelemetry 日志发送到 GreptimeDB 的示例代码：
+
+```hcl
+loki.source.file "greptime" {
+  targets = [
+    {__path__ = "/tmp/foo.txt"},
+  ]
+  forward_to = [otelcol.receiver.loki.greptime.receiver]
+}
+
+otelcol.receiver.loki "greptime" {
+  output {
+    logs = [otelcol.exporter.otlphttp.greptimedb_logs.input]
+  }
+}
+
+otelcol.auth.basic "credentials" {
+  username = "${GREPTIME_USERNAME}"
+  password = "${GREPTIME_PASSWORD}"
+}
+
+otelcol.exporter.otlphttp "greptimedb_logs" {
+  client {
+    endpoint = "${GREPTIME_SCHEME:=http}://${GREPTIME_HOST:=greptimedb}:${GREPTIME_PORT:=4000}/v1/otlp/"
+    headers  = {
+      "X-Greptime-DB-Name" = "${GREPTIME_DB:=public}",
+      "x-greptime-log-table-name" = "demo_logs",
+      "x-greptime-log-extract-keys" = "filename,log.file.name,loki.attribute.labels",
+    }
+    auth     = otelcol.auth.basic.credentials.handler
+  }
+}
+```
+
+此示例监听文件的变化，并通过 OTLP 协议将最新的值发送到 GreptimeDB。
+
+:::tip 提示
+上述示例代码可能会因 OpenTelemetry 的更新而过时。我们建议您参考 OpenTelemetry 和 Grafana Alloy 的官方文档以获取最新信息。
+:::
+
+有关示例代码的更多信息，请参考您首选编程语言的官方文档。
+
+#### 数据模型
+
+OTLP 日志数据模型根据以下规则映射到 GreptimeDB 数据模型：
+
+默认表结构：
+
+```sql
++-----------------------+---------------------+------+------+---------+---------------+
+| Column                | Type                | Key  | Null | Default | Semantic Type |
++-----------------------+---------------------+------+------+---------+---------------+
+| timestamp             | TimestampNanosecond | PRI  | NO   |         | TIMESTAMP     |
+| trace_id              | String              |      | YES  |         | FIELD         |
+| span_id               | String              |      | YES  |         | FIELD         |
+| severity_text         | String              |      | YES  |         | FIELD         |
+| severity_number       | Int32               |      | YES  |         | FIELD         |
+| body                  | String              |      | YES  |         | FIELD         |
+| log_attributes        | Json                |      | YES  |         | FIELD         |
+| trace_flags           | UInt32              |      | YES  |         | FIELD         |
+| scope_name            | String              | PRI  | YES  |         | TAG           |
+| scope_version         | String              |      | YES  |         | FIELD         |
+| scope_attributes      | Json                |      | YES  |         | FIELD         |
+| scope_schema_url      | String              |      | YES  |         | FIELD         |
+| resource_attributes   | Json                |      | YES  |         | FIELD         |
+| resource_schema_url   | String              |      | YES  |         | FIELD         |
++-----------------------+---------------------+------+------+---------+---------------+
+17 rows in set (0.00 sec)
+```
+
+- 您可以使用 `X-Greptime-Log-Table-Name` 指定存储日志的表名。如果未提供，默认表名为 `opentelemetry_logs`。
+- 所有属性，包括资源属性、范围属性和日志属性，将作为 JSON 列存储在 GreptimeDB 表中。
+- 日志的时间戳将用作 GreptimeDB 中的时间戳索引，列名为 `timestamp`。建议使用 `time_unix_nano` 作为时间戳列。如果未提供 `time_unix_nano`，将使用 `observed_time_unix_nano`。