clickhouse-logger

Attributes

NOTE: encrypt_fields = {"password"} is also defined in the schema, which means that the field will be stored encrypted in etcd. See .

This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every 5 seconds or when the data in the queue reaches 1000. See Batch Processor for more information or setting your custom configuration.

NameTypeRequiredDefaultDescription
log_formatobjectFalse{“host”: “$host”, “@timestamp”: “$time_iso8601”, “client_ip”: “$remote_addr”}Log format declared as key value pairs in JSON format. Values only support strings. APISIX or variables can be used by prefixing the string with $.
IMPORTANT

Configuring the Plugin metadata is global in scope. This means that it will take effect on all Routes and Services which use the clickhouse-logger Plugin.

The example below shows how you can configure through the Admin API:

  1. CREATE TABLE default.test (
  2.   `host` String,
  4.   `route_id` String,
  5.   `service_id` String,
  6.   `@timestamp` String,
  7.    PRIMARY KEY(`@timestamp`)

Now, if you run select * from default.test;, you will get the following row:

Enabling the Plugin

If multiple endpoints are configured, they will be written randomly. The example below shows how you can enable the Plugin on a specific Route:

  1. curl http://127.0.0.1:9180/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_addrs": ["http://127.0.0.1:8123"]
  10.             }
  11.        },
  12.       "upstream": {
  14.            "nodes": {
  15.            }
  16.       },
  17.       "uri": "/hello"
  18. }'

Disable Plugin

To disable the clickhouse-logger Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

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