clickhouse-logger

描述

clickhouse-logger 是一个插件,可将 Log 数据请求推送到 clickhouse 服务器。

属性

名称类型必选项默认值有效值描述
endpoint_addrstring必须clickhouse 服务器的 endpoint。
databasestring必须使用的数据库。
logtablestring必须写入的表名 。
userstring必须clickhouse 的用户。
passwordstring必须clickhouse 的密码 。
timeoutinteger可选3[1,…]发送请求后保持连接活动的时间。
namestring可选“clickhouse logger”标识 logger 的唯一标识符。
ssl_verifyboolean可选true[true,false]验证证书。

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

如何开启

这是有关如何为特定路由启用 clickhouse-logger 插件的示例。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "plugins": {
  4. "clickhouse-logger": {
  5. "user": "default",
  6. "password": "a",
  7. "database": "default",
  8. "logtable": "test",
  9. "endpoint_addr": "http://127.0.0.1:8123"
  10. }
  11. },
  12. "upstream": {
  13. "type": "roundrobin",
  14. "nodes": {
  15. "127.0.0.1:1980": 1
  16. }
  17. },
  18. "uri": "/hello"
  19. }'

测试插件

成功:

  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. hello, world

插件元数据设置

名称类型必选项默认值有效值描述
log_formatobject可选{“host”: “$host”, “@timestamp”: “$time_iso8601”, “client_ip”: “$remote_addr”}以 JSON 格式的键值对来声明日志格式。对于值部分,仅支持字符串。如果是以 $ 开头,则表明是要获取 APISIX 变量Nginx 内置变量。请注意,该设置是全局生效的,因此在指定 log_format 后,将对所有绑定 clickhouse-logger 的 Route 或 Service 生效。

设置日志格式示例

  1. curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/clickhouse-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "log_format": {
  4. "host": "$host",
  5. "@timestamp": "$time_iso8601",
  6. "client_ip": "$remote_addr"
  7. }
  8. }'

创建 clickhouse log table

  1. CREATE TABLE default.test (
  2. `host` String,
  3. `client_ip` String,
  4. `route_id` String,
  5. `@timestamp` String,
  6. PRIMARY KEY(`@timestamp`)
  7. ) ENGINE = MergeTree()

在 clickhouse 上执行select * from default.test;,将得到类似下面的数据:

  1. ┌─host──────┬─client_ip─┬─route_id─┬─@timestamp────────────────┐
  2. 127.0.0.1 127.0.0.1 1 2022-01-17T10:03:10+08:00
  3. └───────────┴───────────┴──────────┴───────────────────────────┘

禁用插件

在插件配置中删除相应的 json 配置以禁用 clickhouse-logger。APISIX 插件是热重载的,因此无需重新启动 APISIX:

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