How to get APISIX variable

[renshunhang]

In the plugin I developed, I want to use APISIX variable, such as balancer_ip. Which method should I use to obtain them?

[dosubot[bot]]

Hello @renshunhang! I'm Dosu, your friendly bot here to help you with bugs, answer questions, and guide you on your journey to becoming a contributor! While you wait for a human maintainer, feel free to ask anything. 😊

To obtain the balancer_ip variable in the APISIX plugin you developed, you can access it as it is a core variable provided by APISIX. You can define a method in your plugin to access the balancer_ip as follows:

function _M.balancer(conf, ctx)
    core.log.notice("IP: ", ctx.balancer_ip, ", Port: ", ctx.balancer_port)
end

In this example, ctx.balancer_ip will give you the IP of the picked upstream server, and you can use it within your plugin to execute specific logic after the upstream node is selected and before accessing the upstream. This method is also applicable before each retry ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[renshunhang]

Hello @renshunhang! I'm Dosu, your friendly bot here to help you with bugs, answer questions, and guide you on your journey to becoming a contributor! While you wait for a human maintainer, feel free to ask anything. 😊

To obtain the balancer_ip variable in the APISIX plugin you developed, you can access it as it is a core variable provided by APISIX. You can define a method in your plugin to access the balancer_ip as follows:

function _M.balancer(conf, ctx)
    core.log.notice("IP: ", ctx.balancer_ip, ", Port: ", ctx.balancer_port)
end

In this example, ctx.balancer_ip will give you the IP of the picked upstream server, and you can use it within your plugin to execute specific logic after the upstream node is selected and before accessing the upstream. This method is also applicable before each retry [1][2].

To continue talking to Dosu, mention @dosu.

Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other

Can I obtain it in the _M.rewrite method? However, when I use ctx.balancer_ip in _M.rewrite method, I get nil.

[dosubot[bot]]

The balancer_ip variable is populated during the balancer phase, specifically when a server is picked from the upstream nodes. Therefore, it is not available in the _M.rewrite method, as this method runs before the balancer phase. To access balancer_ip, you should use it in the _M.balancer method, where it is set after selecting the upstream node ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}