Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • endpoint_addrs

    array[string]


    required


    Elasticsearch API endpoint addresses. If multiple endpoints are configured, they will be written randomly.

  • field

    object


    required


    Elasticsearch field configurations.

    • index

      string


      required


      Elasticsearch _index field.

    • type

      string


      required


      Elasticsearch _type field.

  • 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 elasticsearch-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.

  • auth

    object


    Elasticsearch user authentication configurations.

    • username

      string


      Elasticsearch authentication username.

    • password

      string


      Elasticsearch authentication password. The secret is encrypted with AES before saving to etcd.

  • ssl_verify

    boolean


    default: true


    If true, perform SSL verification.

  • timeout

    integre


    default: 10


    Elasticsearch send data timeout in seconds.

  • 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.


API7.ai Logo

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

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2025. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation