Skip to main content

Error Log Collect Configuration

The error-log-collect plugin captures the error logs produced while processing selected requests, including lower-severity entries that the configured log level would otherwise discard, and writes them to the gateway error log for targeted debugging. Configuration covers plugin parameters.

Parameters​

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

  • vars

    array[array]


    An array of one or more matching conditions in the form of APISIX expressions. The buffered logs are flushed to the error log only when all expressions evaluate to true. When unset, the logs are collected for every request.

  • sample_ratio

    number

    default: 1

    vaild vaule:

    between 0.00001 and 1 inclusive


    Probability of collecting the logs for a request. The default value of 1 collects the logs for all requests. Set to a value below 1 to collect the logs for a random sample of requests.

  • buffer_max_size

    integer

    default: 1000

    vaild vaule:

    greater than or equal to 1


    Maximum number of log entries held in the per-worker buffer. When the number of buffered logs exceeds this value, the oldest entries are overwritten.