clickhouse-logger

描述

clickhouse-logger 插件可用于将日志数据推送到 ClickHouse 数据库中。

属性

名称类型必选项默认值有效值描述
endpoint_addr废弃是ClickHouse 的 endpoints。请使用 endpoint_addrs 代替。
endpoint_addrsarray是ClickHouse 的 endpoints。。
databasestring是使用的数据库。
logtablestring是写入的表名。
userstring是ClickHouse 的用户。
passwordstring是ClickHouse 的密码。
timeoutinteger否3[1,…]发送请求后保持连接活动的时间。
namestring否“clickhouse logger”标识 logger 的唯一标识符。如果您使用 Prometheus 监视 APISIX 指标，名称将以 apisix_batch_process_entries 导出。
ssl_verifyboolean否true[true,false]当设置为 true 时，验证证书。
log_formatobject否以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头，则表明是要获取 APISIX 变量 或 NGINX 内置变量。
include_req_bodyboolean否false[false, true]当设置为 true 时，包含请求体。注意：如果请求体无法完全存放在内存中，由于 NGINX 的限制，APISIX 无法将它记录下来。
include_req_body_exprarray否当 include_req_body 属性设置为 true 时进行过滤。只有当此处设置的表达式计算结果为 true 时，才会记录请求体。更多信息，请参考 lua-resty-expr。
include_resp_bodyboolean否false[false, true]当设置为 true 时，包含响应体。
include_resp_body_exprarray否当 include_resp_body 属性设置为 true 时进行过滤。只有当此处设置的表达式计算结果为 true 时才会记录响应体。更多信息，请参考 lua-resty-expr。

注意：schema 中还定义了 encrypt_fields = {"password"}，这意味着该字段将会被加密存储在 etcd 中。具体参考 加密存储字段。

该插件支持使用批处理器来聚合并批量处理条目（日志/数据）。这样可以避免插件频繁地提交数据，默认情况下批处理器每 5 秒钟或队列中的数据达到 1000 条时提交数据，如需了解批处理器相关参数设置，请参考 Batch-Processor。

默认日志格式示例

  1. {
  2.     "response": {
  3.         "status": 200,
  4.         "size": 118,
  5.         "headers": {
  6.             "content-type": "text/plain",
  7.             "connection": "close",
  8.             "server": "APISIX/3.7.0",
  9.             "content-length": "12"
  10.         }
  11.     },
  12.     "client_ip": "127.0.0.1",
  13.     "upstream_latency": 3,
  14.     "apisix_latency": 98.999998092651,
  15.     "upstream": "127.0.0.1:1982",
  16.     "latency": 101.99999809265,
  17.     "server": {
  18.         "version": "3.7.0",
  19.         "hostname": "localhost"
  20.     },
  21.     "route_id": "1",
  22.     "start_time": 1704507612177,
  23.     "service_id": "",
  24.     "request": {
  25.         "method": "POST",
  26.         "querystring": {
  27.             "foo": "unknown"
  28.         },
  29.         "headers": {
  30.             "host": "localhost",
  31.             "connection": "close",
  32.             "content-length": "18"
  33.         },
  34.         "size": 110,
  35.         "uri": "/hello?foo=unknown",
  36.         "url": "http://localhost:1984/hello?foo=unknown"
  37.     }
  38. }

配置插件元数据

clickhouse-logger 也支持自定义日志格式，与 http-logger 插件类似。

名称类型必选项默认值有效值描述
log_formatobject否以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头，则表明是要获取 APISIX 或 NGINX 变量。该配置全局生效。如果你指定了 log_format，该配置就会对所有绑定 clickhouse-logger 的路由或服务生效。
clickhouse-logger - 图1note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/clickhouse-logger \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.     "log_format": {
  5.         "host": "$host",
  6.         "@timestamp": "$time_iso8601",
  7.         "client_ip": "$remote_addr"
  8.     }
  9. }'

您可以使用 Clickhouse docker 镜像来创建一个容器，如下所示：

  1. docker run -d -p 8123:8123 -p 9000:9000 -p 9009:9009 --name some-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server

然后在您的 ClickHouse 数据库中创建一个表来存储日志。

  1. curl -X POST 'http://localhost:8123/' \
  2. --data-binary 'CREATE TABLE default.test (host String, client_ip String, route_id String, service_id String, `@timestamp` String, PRIMARY KEY(`@timestamp`)) ENGINE = MergeTree()' --user default:

启用插件

你可以通过以下命令在指定路由中启用该插件：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.       "plugins": {
  5.             "clickhouse-logger": {
  6.                 "user": "default",
  7.                 "password": "",
  8.                 "database": "default",
  9.                 "logtable": "test",
  10.                 "endpoint_addrs": ["http://127.0.0.1:8123"]
  11.             }
  12.        },
  13.       "upstream": {
  14.            "type": "roundrobin",
  15.            "nodes": {
  16.                "127.0.0.1:1980": 1
  17.            }
  18.       },
  19.       "uri": "/hello"
  20. }'
clickhouse-logger - 图2注意

如果配置多个 endpoints，日志将会随机写入到各个 endpoints。

测试插件

现在你可以向 APISIX 发起请求：

  1. curl -i http://127.0.0.1:9080/hello

现在，如果您检查表中的行，您将获得以下输出：

  1. curl 'http://localhost:8123/?query=select%20*%20from%20default.test'
  2. 127.0.0.1   127.0.0.1   1       2023-05-08T19:15:53+05:30

删除插件

当你需要删除该插件时，可通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1  \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/hello",
  6.     "plugins": {},
  7.     "upstream": {
  8.         "type": "roundrobin",
  9.         "nodes": {
  10.             "127.0.0.1:1980": 1
  11.         }
  12.     }
  13. }'