Deprecated. Use brokers instead. A map of Kafka broker hosts to their ports. Configure either broker_list or brokers.

Target topic to push the logs for organization.

Kafka producer mode. In async mode, messages are buffered locally before being sent to Kafka. In sync mode, messages are sent without using the async producer buffer.

Number of acknowledgements the leader needs to receive for the producer to consider the request complete. This controls the durability of the sent records. See Kafka documentation for more information. acks=0 is not yet supported.

Kafka Produce API version used to send messages to the broker. Only version 2 carries the message timestamp, allowing the broker to store it; with the default 1, messages may be recorded without a usable timestamp. Available in API7 Enterprise from version 3.9.14.

Key used for allocating partitions for messages.

Timeout for the upstream to send data.

Format to collect the request information. Setting to default collects the information in JSON format and origin collects the information with the original HTTP request. See the example for more details.

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.

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.

Maximum request body allowed in bytes. Request bodies falling within this limit will be pushed to Kafka. If the size exceeds the configured value, the body will be truncated before being pushed to Kafka.

If true, include the response body in the log.

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.

Maximum response body allowed in bytes. Response bodies falling within this limit will be pushed to Kafka. If the size exceeds the configured value, the body will be truncated before being pushed to Kafka.

Name of the cluster. Used when there are two or more Kafka clusters. Only works if producer_type is set to async.

The number of messages to send in one batch. Same as the batch_num parameter in lua-resty-kafka.

The size of the TCP send buffer to use when sending data. Same as the batch_size parameter in lua-resty-kafka, but in bytes.

Maximum number of Kafka producer messages that the async producer can buffer locally. Same as the max_buffering parameter in lua-resty-kafka. This buffer is not capped by max_pending_entries. Memory usage also depends on worker count, batch_max_size, log format, and whether request or response bodies are logged.

Flush time. Same as the flush_time parameter in lua-resty-kafka, but in seconds.

Time interval to auto refresh the metadata. Same as the refresh_interval parameter in lua-resty-kafka, but in seconds.

Unique identifier of the plugin for the batch processor. If you use Prometheus to monitor APISIX metrics, the name is exported in apisix_batch_process_entries.

The number of log entries allowed in one batch. Once reached, the batch will be sent to the logging service. Setting this parameter to 1 means immediate processing.

The maximum time in seconds to wait for new logs before sending the batch to the logging service. The value should be smaller than buffer_duration.

The maximum time in seconds from the earliest entry allowed before sending the batch to the logging service.

The time interval in seconds to retry sending the batch to the logging service if the batch was not successfully sent.

The maximum number of unsuccessful retries allowed before dropping the log entries.

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 setting does not limit the async Kafka producer's local buffer.