Project: APISIX (Orchestration & Management / API Gateway)
File: tcp-logger.md

title: tcp-logger keywords: Apache APISIX API Gateway Plugin TCP Logger tcp-logger description: This document contains information about the Apache APISIX tcp-logger Plugin. <!-- --> The `tcp-logger` Plugin can be used to push log data requests to TCP servers. This provides the ability to send log data requests as JSON objects to monitoring tools and other TCP servers. This plugin also allows to push logs as a batch to your external TCP server. It might take some time to receive the log data. It will be automatically sent after the timer function in the expires. | Name | Type | Required | Default | Valid values | Description | |||-||--|-| | host | string | True | | | IP address or the hostname of the TCP server. | | port | integer | True | | [0,...] | Target upstream port. | | timeout | integer | False | 1000 | [1,...] | Timeout for the upstream to send data. | | log_format | object | False | | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | | tls | boolean | False | false | | When set to `true` performs SSL verification. | | tls_options | string | False | | | TLS options. | | includereqbody | boolean | False | false | [false, true] | When set to `true` includes the request body in the log. | | includereqbodyexpr | array | No | | | Filter for when the `includereq_body` attribute is set to `true`. Request body is only logged when the expression set here evaluates to `true`. See for more. | | includerespbody | boolean | No | false | [false, true] | When set to `true` includes the response body in the log. | | includerespbodyexpr | array | No | | | Filter for when the `includeresp_body` attribute is set to `true`. Response body is only logged when the expression set here evaluates to `true`. See for more. | 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

See for more information or setting your custom configuration. ```json { "response": { "status": 200, "headers": { "server": "APISIX/3.7.0", "content-type": "text/plain", "content-length": "12", "connection": "close" }, "size": 118 }, "server": { "version": "3.7.0", "hostname": "localhost" }, "start_time": 1704527628474, "client_ip": "127.0.0.1", "service_id": "", "latency": 102.9999256134, "apisix_latency": 100.9999256134, "upstream_latency": 2, "request": { "headers": { "connection": "close", "host": "localhost" }, "size": 59, "method": "GET", "uri": "/hello", "url": "http://localhost:1984/hello", "querystring": {} }, "upstream": "127.0.0.1:1980", "route_id": "1" } ``` 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 | | Log format declared as key value pairs in JSON format. Values only support strings. or 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 `tcp-logger` Plugin. ::: The example below shows how you can configure through the Admin API: :::note You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash adminkey=$(yq '.deployment.admin.adminkey[0].key' conf/config.yaml | sed 's/"//g') ``` ::: ```shell curl http://127.0.0.1:9180/apisix/admin/pluginmetadata/tcp-logger -H "X-API-KEY: $adminkey" -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "clientip": "$remoteaddr" } }' ``` With this configuration, your logs would be formatted as shown below: ```json {"@timestamp":"2023-01-09T14:47:25+08:00","routeid":"1","host":"localhost","clientip":"127.0.0.1"} ``` The example below shows how you can enable the `tcp-logger` Plugin on a specific Route: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/5 -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "tcp-logger": { "host": "127.0.0.1", "port": 5044, "tls": false, "batchmaxsize": 1, "name": "tcp logger" } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` Now, if you make a request to APISIX, it will be logged in your TCP server: ```shell curl -i http://127.0.0.1:9080/hello ``` To remove the `tcp-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. ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "methods": ["GET"], "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }' ```