Skip to main content
Version: 3.0



The clickhouse-logger Plugin is used to push logs to ClickHouse database.


NameTypeRequiredDefaultValid valuesDescription
endpoint_addrDeprecatedTrueUse endpoint_addrs instead. ClickHouse endpoints.
endpoint_addrsarrayTrueClickHouse endpoints.
databasestringTrueName of the database to store the logs.
logtablestringTrueTable name to store the logs.
userstringTrueClickHouse username.
passwordstringTrueClickHouse password.
timeoutintegerFalse3[1,...]Time to keep the connection alive for after sending a request.
namestringFalse"clickhouse logger"Unique identifier for the logger.
ssl_verifybooleanFalsetrue[true,false]When set to true, verifies SSL.

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.


You can also set the format of the logs by configuring the Plugin metadata. The following configurations are available:

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 Nginx variables can be used by prefixing the string with $.

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:

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"log_format": {
"host": "$host",
"@timestamp": "$time_iso8601",
"client_ip": "$remote_addr"

You have to then create a table in your ClickHouse database to store the logs:

CREATE TABLE default.test (
`host` String,
`client_ip` String,
`route_id` String,
`service_id` String,
`@timestamp` String,
PRIMARY KEY(`@timestamp`)
) ENGINE = MergeTree()

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

┌─host──────┬─client_ip─┬─route_id─┬─@timestamp────────────────┐ │ │ 12022-01-17T10:03:10+08:00 │

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:

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"plugins": {
"clickhouse-logger": {
"user": "default",
"password": "a",
"database": "default",
"logtable": "test",
"endpoint_addrs": [""]
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1
"uri": "/hello"

Example usage#

Now, if you make a request to APISIX, it will be logged in your ClickHouse database:

curl -i

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.

curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"uri": "/hello",
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1