Skip to main content

Static Configurations

By default, timeout values for the plugin are pre-configured in the default configuration file:

plugin_attr:
proxy-mirror:
timeout:
connect: 60s
read: 60s
send: 60s

To customize these values, add the corresponding configurations to config.yaml, which takes precedence over the configurations in config-default.yaml. Reload APISIX for changes to take effect.

Parameters

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

  • host

    string


    required


    Address of the host to forward the mirrored traffic to. The address should contain the scheme but without the path, such as http://127.0.0.1:8081.

  • path

    string


    Path of the host to forward the mirrored traffic to. If unspecified, default to the current URI path of the route. Not applicable if the plugin is mirroring gRPC traffic.

  • path_concat_mode

    string


    default: replace


    vaild vaule:

    replace or prefix


    Concatenation mode when path is specified. When set to replace, the configured path would be directly used as the path of the host to forward the mirrored traffic to. When set to prefix, the path to forward to would be the configured path, appended by the requested URI path of the route. Not applicable if the plugin is mirroring gRPC traffic.

  • sample_ratio

    number


    default: 1


    vaild vaule:

    between 0.00001 and 1 inclusive


    Ratio of the requests that will be mirrored. By default, all traffic are mirrored.


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