Skip to main content

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: 3


    vaild 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-logger plugin 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: false


    If 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


    An array of one or more conditions in the form of APISIX expressions. Used when the include_req_body is true. Request body would only be logged when the expressions configured here evaluate to true.

  • include_resp_body

    boolean


    default: false


    If true, include the response body in the log.

  • include_resp_body_expr

    array


    An array of one or more conditions in the form of APISIX expressions. Used when the include_resp_body is true. Response body would only be logged when the expressions configured here evaluate to true.

  • include_resp_body_expr

    array


    An array of one or more conditions in the form of APISIX expressions. Used when the include_resp_body is true. Response body would only be logged when the expressions configured here evaluate to true.

  • concat_method

    string


    default: json


    vaild vaule:

    json or new_line


    Method to concatenate logs. When set to json, use json.encode for all pending logs. When set to new_line, also use json.encode but use the newline character to concatenate lines.

  • ssl_verify

    boolean


    default: false


    If true, verify the server's SSL certificate.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation