proxy-mirror

Description

The proxy-mirror Plugin can be used to mirror client requests.

note

The response returned by the mirror request is ignored.

Attributes

Name	Type	Required	Default	Valid values	Description
host	string	True			Address of the mirror service. It needs to contain the scheme but without the path. For example, http://127.0.0.1:9797.
path	string	False			Path of the mirror request. If unspecified, current path will be used.
sample_ratio	number	False	1	[0.00001, 1]	Ratio of the requests that will be mirrored.

You can customize the proxy timeouts for the mirrored sub-requests by configuring the plugin_attr key in your configuration file (conf/config.yaml). This can be used for mirroring traffic to a slow backend.

conf/config.yaml

plugin_attr:  proxy-mirror:    timeout:      connect: 2000ms      read: 2000ms      send: 2000ms

Name	Type	Default	Description
connect	string	60s	Connect timeout to the mirrored Upstream.
read	string	60s	Read timeout to the mirrored Upstream.
send	string	60s	Send timeout to the mirrored Upstream.

Enabling the Plugin

You can enable the Plugin on a specific Route as shown below:

curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "plugins": {        "proxy-mirror": {           "host": "http://127.0.0.1:9797"        }    },    "upstream": {        "nodes": {            "127.0.0.1:1999": 1        },        "type": "roundrobin"    },    "uri": "/hello"}'

Example usage

Once you have configured the Plugin as shown above, the requests made will be mirrored to the configured host.

curl http://127.0.0.1:9080/hello -i

HTTP/1.1 200 OKContent-Type: application/octet-streamContent-Length: 12Connection: keep-aliveServer: APISIX web serverDate: Wed, 18 Mar 2020 13:01:11 GMTLast-Modified: Thu, 20 Feb 2020 14:21:41 GMT
hello world

tip

For testing you can create a test server by running:

python -m http.server 9797

Disable Plugin

To disable the proxy-mirror Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1999": 1        }    }}'