API Proxy timeout
My client is an Apigee Cloud customer and we have an issue with timeouts.
As per the documentation here,
| Cloud customers, who can't modify the Edge timeouts, can also configure an API proxy timeout, as long as the timeout is shorter than the standard Edge message processor timeout of 57 seconds. |
Our backend application sometimes takes as much as 300 seconds to respond back. So when this happens, while the message processor is perfectly ok with waiting for the backend to respond (io.timeout.millis, connect.timeout.millis and keepalive.timeout.millis set to appropriate values), the router responds back with a 504 Gateway Timeout error in HTML
<!DOCTYPE html>
<html>
<head>
<title>Error</title>
<style>
body {
width: 35em;
margin: 0 auto;
font-family: Tahoma, Verdana, Arial, sans-serif;
}
</style>
</head>
<body>
<h1>An error occurred.</h1>
<p>Sorry, the page you are looking for is currently unavailable.
<br/>
Please try again later.
</p>
</body>
</html>
So how do I ensure that my client does not get this error back for a transction that takes longer than 57 seconds?
I recently had a discussion about the same issue with the Apigee support and what they suggested is to change the proxy_read_timeout setting on the virtual host.
You can do this by 2 ways:
- From the Edge UI, navigate to Admin - Virtual Hosts section, change this setting in a particular vHost.
-
You can use the Apigee update virtual host management API for this purpose as well:
https://apidocs.apigee.com/management/apis/put/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/virtualhosts/%7Bvirtualhost_name%7D
Note:
- The proxy_read_timeout value should be greater than the io.timeout.millis. This ensure proxy will timeout only when the wait time for target to respond is over.
- Once you update a vHost, it will impact all the proxies in that environment. It means, the proxy read timeout will be applied to those proxies as well that don't need it.
This is what have helped me but I also noticed one thing: proxy doesn't timeout exactly as per the value in the proxy read timeout. It usually takes more time.
Having said that, I would like other people's comments on this topic as well.
thanks
Hi @Mohammad
Thank you for the information. But is there a way where we don't have to update the timeout of the virtual host? Is there a way where in we can adjust timeout inside the API Proxy?
Thanks
I think we can mention the same property in the proxy endpoint section but I am not sure if that actually changes the setting at the vHost for that particular proxy.
same error. is there a solution for this in API proxy level?
Have you tried following property in your TargetEndpoint ?
<Properties><Property name="io.timeout.millis">180000</Property> </Properties>.
This should work on API proxy level. 180 is an example btw.
