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 in key-value pairs in JSON format. Support built-in variables in values.
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