Parameters
See plugin common configurations for configuration options available to all plugins.
uri
string
required
URI of the HTTP(S) server.
auth_header
string
Authorization headers, if required by the HTTP(S) server.
timeout
integer
default:
3vaild vaule:
greater than 0
Time to keep the connection alive after sending a request.
log_format
object
Custom log format using key-value pairs in JSON format. Values can reference built-in variables.
In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.
You can also configure log format on a global scale using the plugin metadata, which configures the log format for all
http-loggerplugin instances. If the log format configured on the individual plugin instance differs from the log format configured on plugin metadata, the log format configured on the individual plugin instance takes precedence. See the example for more details.include_req_body
boolean
default:
falseIf true, include the request body in the log. Note that if the request body is too big to be kept in the memory, it can not be logged due to NGINX's limitations.
include_req_body_expr
array[array]
An array of one or more conditions in the form of APISIX expressions. Used when the
include_req_bodyis true. Request body would only be logged when the expressions configured here evaluate to true.include_resp_body
boolean
default:
falseIf true, include the response body in the log.
include_resp_body_expr
array[array]
An array of one or more conditions in the form of APISIX expressions. Used when the
include_resp_bodyis true. Response body would only be logged when the expressions configured here evaluate to true.concat_method
string
default:
jsonvaild vaule:
jsonornew_lineMethod to concatenate logs. When set to
json, usejson.encodefor all pending logs. When set tonew_line, also usejson.encodebut use the newline characterssl_verify
boolean
default:
falseIf true, verify the server's SSL certificate.
Plugin Metadata
log_format
object
Custom log format using key-value pairs in JSON format. Values can reference built-in variables.
In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.
max_pending_entries
integer
vaild vaule:
greater than or equal to 1
Maximum number of unprocessed entries allowed in the batch processor. When this limit is reached, new entries will be dropped until the backlog is reduced. This helps prevent memory spikes when the logger is slow or unavailable.
This parameter is available in API7 Enterprise from version 3.8.17 and in APISIX from version 3.15.0.