http-logger
is a plugin which push Log data requests to HTTP/HTTPS servers.
This will provide the ability to send Log data requests as JSON objects to Monitoring tools and other HTTP servers.
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
uri | string | required | URI of the server | ||
auth_header | string | optional | "" | Any authorization headers | |
timeout | integer | optional | 3 | [1,...] | Time to keep the connection alive after sending a request |
name | string | optional | “http logger” | A unique identifier to identity the logger | |
batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch |
inactive_timeout | integer | optional | 5 | [1,...] | Maximum age in seconds when the buffer will be flushed if inactive |
buffer_duration | integer | optional | 60 | [1,...] | Maximum age in seconds of the oldest entry in a batch before the batch must be processed |
max_retry_count | integer | optional | 0 | [0,...] | Maximum number of retries before removing from the processing pipe line |
retry_delay | integer | optional | 1 | [0,...] | Number of seconds the process execution should be delayed if the execution fails |
include_req_body | boolean | optional | false | Whether to include the request body | |
concat_method | string | optional | “json” | Enum type, json and new_line . json: use json.encode for all pending logs. new_line: use json.encode for each pending log and concat them with “\n” line. |
The following is an example on how to enable the http-logger for a specific route.
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "http-logger": { "uri": "http://127.0.0.1:80/postendpoint?param=1", } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }'
success:
$ curl -i http://127.0.0.1:9080/hello HTTP/1.1 200 OK ... hello, world
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
log_format | object | optional | Log format declared as JSON object. Only string is supported in the value part. If the value starts with $ , the value is Nginx variable. |
Note that the metadata configuration is applied in global scope, which means it will take effect on all Route or Service which use http-logger plugin.
curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/http-logger -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr" } }'
It is expected to see some logs like that:
{"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"} {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
Remove the corresponding json configuration in the plugin configuration to disable the http-logger
. APISIX plugins are hot-reloaded, therefore no need to restart APISIX.
$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }'