http-logger

Description

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.

Attributes

NameTypeRequiredDefaultValid valuesDescription
uristringTrueURI of the HTTP/HTTPS server.
auth_headerstringFalseAuthorization headers if required.
timeoutintegerFalse3[1,…]Time to keep the connection alive for after sending a request.
log_formatobjectFalseLog 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 $.
include_req_bodybooleanFalsefalse[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.
include_req_body_exprarrayFalseFilter for when the include_req_body attribute is set to true. Request body is only logged when the expression set here evaluates to true. See lua-resty-expr for more.
include_resp_bodybooleanFalsefalse[false, true]When set to true includes the response body in the log.
include_resp_body_exprarrayFalseWhen the include_resp_body attribute is set to true, use this to filter based on lua-resty-expr. If present, only logs the response if the expression evaluates to true.
concat_methodstringFalse“json”[“json”, “new_line”]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_verifybooleanFalsefalse[false, true]When set to true verifies the SSL certificate.
http-logger - 图1note

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.

Example of default log format

  1. {
  2. "service_id": "",
  3. "apisix_latency": 100.99999809265,
  4. "start_time": 1703907485819,
  5. "latency": 101.99999809265,
  6. "upstream_latency": 1,
  7. "client_ip": "127.0.0.1",
  8. "route_id": "1",
  9. "server": {
  10. "version": "3.7.0",
  11. "hostname": "localhost"
  12. },
  13. "request": {
  14. "headers": {
  15. "host": "127.0.0.1:1984",
  16. "content-type": "application/x-www-form-urlencoded",
  17. "user-agent": "lua-resty-http/0.16.1 (Lua) ngx_lua/10025",
  18. "content-length": "12"
  19. },
  20. "method": "POST",
  21. "size": 194,
  22. "url": "http://127.0.0.1:1984/hello?log_body=no",
  23. "uri": "/hello?log_body=no",
  24. "querystring": {
  25. "log_body": "no"
  26. }
  27. },
  28. "response": {
  29. "headers": {
  30. "content-type": "text/plain",
  31. "connection": "close",
  32. "content-length": "12",
  33. "server": "APISIX/3.7.0"
  34. },
  35. "status": 200,
  36. "size": 123
  37. },
  38. "upstream": "127.0.0.1:1982"
  39. }

Metadata

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

NameTypeRequiredDefaultDescription
log_formatobjectFalseLog 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 $.
http-logger - 图2IMPORTANT

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:

http-logger - 图3note

You can fetch the admin_key from config.yaml and save to an environment variable with the following command:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/http-logger \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "log_format": {
  5. "host": "$host",
  6. "@timestamp": "$time_iso8601",
  7. "client_ip": "$remote_addr"
  8. }
  9. }'

With this configuration, your logs would be formatted as shown below:

  1. {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}
  2. {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","client_ip":"127.0.0.1","route_id":"1"}

Enable Plugin

The example below shows how you can enable the Plugin on a specific Route:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "plugins": {
  5. "http-logger": {
  6. "uri": "http://mockbin.org/bin/:ID"
  7. }
  8. },
  9. "upstream": {
  10. "type": "roundrobin",
  11. "nodes": {
  12. "127.0.0.1:1980": 1
  13. }
  14. },
  15. "uri": "/hello"
  16. }'

As an example the mockbin server is used for mocking an HTTP server to see the logs produced by APISIX.

Example usage

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

  1. curl -i http://127.0.0.1:9080/hello

Delete Plugin

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.

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "uri": "/hello",
  4. "plugins": {},
  5. "upstream": {
  6. "type": "roundrobin",
  7. "nodes": {
  8. "127.0.0.1:1980": 1
  9. }
  10. }
  11. }'