版本：1.2

写入日志的 API

在写入日志之前，请先阅读 Pipeline 配置完成配置的设定和上传。

HTTP API

你可以使用以下命令通过 HTTP 接口写入日志：

curl -X "POST" "http://localhost:4000/v1/ingest?db=<db-name>&table=<table-name>&pipeline_name=<pipeline-name>&version=<pipeline-version>&skip_error=<skip-error>" \
     -H "Content-Type: application/x-ndjson" \
     -H "Authorization: Basic <base64-encoded-credentials>" \
     -d "$<log-items>"

请求参数

此接口接受以下参数：

db：数据库名称。
table：表名称。
pipeline_name：Pipeline 名称。
version：Pipeline 版本号。可选，默认使用最新版本。
skip_error：写入日志时是否跳过错误。可选，默认为 false。当设置为 true 时，GreptimeDB 会跳过遇到错误的单条日志项并继续处理剩余的日志，不会因为一条日志项的错误导致整个请求失败。

`Content-Type` 和 Body 数据格式

GreptimeDB 使用 Content-Type header 来决定如何解码请求体内容。目前我们支持以下两种格式：

application/json: 包括普通的 JSON 格式和 NDJSON 格式。
application/x-ndjson: 指定 NDJSON 格式，会尝试先分割行再进行解析，可以达到精确的错误检查。
text/plain: 通过换行符分割的多行日志文本行。

`application/json` 和 `application/x-ndjson` 格式

以下是一份 JSON 格式请求体内容的示例：

[
     {"message":"127.0.0.1 - - [25/May/2024:20:16:37 +0000] \"GET /index.html HTTP/1.1\" 200 612 \"-\" \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\""},
     {"message":"192.168.1.1 - - [25/May/2024:20:17:37 +0000] \"POST /api/login HTTP/1.1\" 200 1784 \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36\""},
     {"message":"10.0.0.1 - - [25/May/2024:20:18:37 +0000] \"GET /images/logo.png HTTP/1.1\" 304 0 \"-\" \"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:89.0) Gecko/20100101 Firefox/89.0\""},
     {"message":"172.16.0.1 - - [25/May/2024:20:19:37 +0000] \"GET /contact HTTP/1.1\" 404 162 \"-\" \"Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1\""}
]

请注意整个 JSON 是一个数组（包含多行日志）。每个 JSON 对象代表即将要被 Pipeline 引擎处理的一行日志。

JSON 对象中的 key 名，也就是这里的 message，会被用作 Pipeline processor 处理时的 field 名称。比如：

processors:
  - dissect:
      fields:
        # `message` 是 JSON 对象中的 key 名
        - message
      patterns:
        - '%{ip_address} - - [%{timestamp}] "%{http_method} %{request_line}" %{status_code} %{response_size} "-" "%{user_agent}"'
      ignore_missing: true

# pipeline 文件的剩余部分在这里省略

我们也可以将这个请求体内容改写成 NDJSON 的格式，如下所示：

{"message":"127.0.0.1 - - [25/May/2024:20:16:37 +0000] \"GET /index.html HTTP/1.1\" 200 612 \"-\" \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\""}
{"message":"192.168.1.1 - - [25/May/2024:20:17:37 +0000] \"POST /api/login HTTP/1.1\" 200 1784 \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36\""}
{"message":"10.0.0.1 - - [25/May/2024:20:18:37 +0000] \"GET /images/logo.png HTTP/1.1\" 304 0 \"-\" \"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:89.0) Gecko/20100101 Firefox/89.0\""}
{"message":"172.16.0.1 - - [25/May/2024:20:19:37 +0000] \"GET /contact HTTP/1.1\" 404 162 \"-\" \"Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1\""}

注意到最外层的数组符被消去了，现在每个 JSON 对象通过换行符分割而不是 ,。

`text/plain` 格式

GreptimeDB 接受 Content-Type 为 text/plain 的纯文本日志，可直接写入日志源产生的文本。

以下是一份和上述样例请求体内容等价的文本请求示例：

0.0.1 - - [25/May/2024:20:16:37 +0000] "GET /index.html HTTP/1.1" 200 612 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
168.1.1 - - [25/May/2024:20:17:37 +0000] "POST /api/login HTTP/1.1" 200 1784 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36"
0.0.1 - - [25/May/2024:20:18:37 +0000] "GET /images/logo.png HTTP/1.1" 304 0 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:89.0) Gecko/20100101 Firefox/89.0"
16.0.1 - - [25/May/2024:20:19:37 +0000] "GET /contact HTTP/1.1" 404 162 "-" "Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1"

仅需要将 Content-Type header 设置成 text/plain，即可将纯文本请求发送到 GreptimeDB。

主要注意的是，和 JSON 格式自带 key 名可以被 Pipeline processor 识别和处理不同，text/plain 格式直接将整行文本输入到 Pipeline engine。在这种情况下我们可以使用 message 来指代整行输入文本，例如：

processors:
  - dissect:
      fields:
        # 使用 `message` 作为 field 名称
        - message
      patterns:
        - '%{ip_address} - - [%{timestamp}] "%{http_method} %{request_line}" %{status_code} %{response_size} "-" "%{user_agent}"'
      ignore_missing: true

# pipeline 文件的剩余部分在这里省略

对于 text/plain 格式的输入，推荐首先使用 dissect 或者 regex processor 将整行文本分割成不同的字段，以便进行后续的处理。

设置表选项

写入日志的表选项需要在 pipeline 中配置。从 v0.15 开始，pipeline 引擎可以识别特定的变量名称，并且通过这些变量对应的值设置相应的建表选项。结合 vrl 处理器，可以根据输入数据在 pipeline 执行期间设置建表选项。

以下是支持的表选项变量名：

greptime_auto_create_table
greptime_ttl
greptime_append_mode
greptime_merge_mode
greptime_physical_table
greptime_skip_wal

请前往表选项文档了解每一个选项的详细含义。

以下是 pipeline 特有的变量：

greptime_table_suffix: 在给定的目标表后增加后缀

以如下 pipeline 文件为例

processors:
  - date:
      field: time
      formats:
        - "%Y-%m-%d %H:%M:%S%.3f"
      ignore_missing: true
  - vrl:
      source: |
        .greptime_table_suffix, err = "_" + .id
        .greptime_ttl = "1d"
        .

在这份 vrl 脚本中，我们将表后缀变量设置为输入字段中的 id（通过一个下划线连接），然后将 ttl 设置成 1d。然后我们使用如下数据执行写入。

{
  "id": "2436",
  "time": "2024-05-25 20:16:37.217"
}

若请求中的表名为 d_table，最终写入的表为 d_table_2436，TTL 为 1 天。

示例

请参考快速开始和使用自定义 pipeline 中的写入日志部分的文档。

写入日志的 API

HTTP API​

请求参数​

Content-Type 和 Body 数据格式​

application/json 和 application/x-ndjson 格式​

text/plain 格式​

设置表选项​

示例​