Skip to content

Latest commit

 

History

History
149 lines (122 loc) · 6.8 KB

clickhouse-logger.md

File metadata and controls

149 lines (122 loc) · 6.8 KB
Raw
title keywords description
clickhouse-logger
APISIX
API Gateway
Plugin
ClickHouse Logger
This document contains information about the Apache APISIX clickhouse-logger Plugin.

Description

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

Attributes

Name Type Required Default Valid values Description
endpoint_addr Deprecated True Use endpoint_addrs instead. ClickHouse endpoints.
endpoint_addrs array True ClickHouse endpoints.
database string True Name of the database to store the logs.
logtable string True Table name to store the logs.
user string True ClickHouse username.
password string True ClickHouse password.
timeout integer False 3 [1,...] Time to keep the connection alive for after sending a request.
name string False "clickhouse logger" Unique identifier for the logger.
ssl_verify boolean False true [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.

Metadata

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

Name Type Required Default Description
log_format object False {"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 $.

:::info 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:

curl http:https://127.0.0.1:9180/apisix/admin/plugin_metadata/clickhouse-logger -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────────────────┐
│ 127.0.0.1 │ 127.0.0.1 │ 1        │ 2022-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 http:https://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
      "plugins": {
            "clickhouse-logger": {
                "user": "default",
                "password": "a",
                "database": "default",
                "logtable": "test",
                "endpoint_addrs": ["http:https://127.0.0.1:8123"]
            }
       },
      "upstream": {
           "type": "roundrobin",
           "nodes": {
               "127.0.0.1:1980": 1
           }
      },
      "uri": "/hello"
}'

Example usage

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

curl -i http:https://127.0.0.1:9080/hello

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 http:https://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'