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

title: http-logger keywords: Apache APISIX API Gateway Plugin HTTP Logger description: This document contains information about the Apache APISIX http-logger Plugin. Using this Plugin, you can push APISIX log data to HTTP or HTTPS servers. <!-- --> The `http-logger` Plugin is used to push log data requests to HTTP/HTTPS servers. This will allow the ability to send log data requests as JSON objects to monitoring tools and other HTTP servers. | Name | Type | Required | Default | Valid values | Description | | - | - | -- | - | -- | | | uri | string | True | | | URI of the HTTP/HTTPS server. | | auth_header | string | False | | | Authorization headers if required. | | timeout | integer | False | 3 | [1,...] | Time to keep the connection alive for after sending a request. | | 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 `$`. | | includereqbody | boolean | False | false | [false, true] | When set to `true` includes the request body in the log. If the request body is too big to be kept in the memory, it can't be logged due to Nginx's limitations. | | includereqbodyexpr | array | False | | | 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 | False | false | [false, true] | When set to `true` includes the response body in the log. | | includerespbodyexpr | array | False | | | When the `includeresp_body` attribute is set to `true`, use this to filter based on . If present, only logs the response if the expression evaluates to `true`. | | concatmethod | string | False | "json" | ["json", "newline"] | Sets how to concatenate logs. When set to `json`, uses `json.encode` for all pending logs and when set to `new_line`, also uses `json.encode` but uses the newline (`\n`) to concatenate lines. | | ssl_verify | boolean | False | false | [false, true] | When set to `true` verifies the SSL certificate. | :::note This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the

The batch processor submits data every `5` seconds or when the data in the queue reaches `1000`. See for more information or setting your custom configuration. ::: ```json { "service_id": "", "apisix_latency": 100.99999809265, "start_time": 1703907485819, "latency": 101.99999809265, "upstream_latency": 1, "client_ip": "127.0.0.1", "route_id": "1", "server": { "version": "3.7.0", "hostname": "localhost" }, "request": { "headers": { "host": "127.0.0.1:1984", "content-type": "application/x-www-form-urlencoded", "user-agent": "lua-resty-http/0.16.1 (Lua) ngx_lua/10025", "content-length": "12" }, "method": "POST", "size": 194, "url": "http://127.0.0.1:1984/hello?log_body=no", "uri": "/hello?log_body=no", "querystring": { "log_body": "no" } }, "response": { "headers": { "content-type": "text/plain", "connection": "close", "content-length": "12", "server": "APISIX/3.7.0" }, "status": 200, "size": 123 }, "upstream": "127.0.0.1:1982" } ``` 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 `http-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/plugin_metadata/http-logger \ -H "X-API-KEY: $admin_key" -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "clientip": "$remoteaddr" } }' ``` With this configuration, your logs would be formatted as shown below: ```shell {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} ``` The example below shows how you can enable the Plugin on a specific Route: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 \ -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "http-logger": { "uri": "http://mockbin.org/bin/:ID" } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` As an example the server is used for mocking an HTTP server to see the logs produced by APISIX. Now, if you make a request to APISIX, it will be logged in your mockbin server: ```shell curl -i http://127.0.0.1:9080/hello ``` To disable this 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 ' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }' ```