Configuring the Router timeout

Edge for Private Cloud v4.18.01

You can configure the Router timeout when accessing Message Processors as part of an API proxy request.

The Edge Router has a default timeout of 57 seconds when attempting to access a Message Processor as part of handling a request through an API proxy. After that timeout expires, the Router attempts to connect to another Message Processor, if one is available. Otherwise, it returns an error.

The following two properties control the Router timeout:

Property Description
conf_load_balancing_load.balancing.driver.proxy.read.timeout
  Specifies the wait time for a single Router. The default value is 57 seconds.

You can set the time interval as something other than seconds by using the following notation:

ms: milliseconds
s:  seconds (default)
m:  minutes
h:  hours
d:  days
w:  weeks
M:  months (length of 30 days)
y:  years (length of 365 days)

For example, to set the wait time to 2 hours, you can use either of the following values:

conf_load_balancing_load.balancing.driver.proxy.read.timeout=2h  # 2 hours
  OR
conf_load_balancing_load.balancing.driver.proxy.read.timeout=120m  # 120 minutes
conf_load_balancing_load.balancing.driver.nginx.upstream_next_timeout
  Specifies the total wait time for all Message Processors when your Edge installation has multiple Message Processors. It has a default value of the current value of conf_load_balancing_load.balancing.driver.proxy.read.timeout, or 57 seconds.

As with the conf_load_balancing_load.balancing.driver.proxy.read.timeout property, you can specify time intervals other than the default (seconds).

To configure the Router's timeout:

  1. Edit the /opt/apigee/customer/application/router.properties file. If the file does not exist, create it.
  2. Set the properties in the configuration file, as the following example shows: 
    conf_load_balancing_load.balancing.driver.proxy.read.timeout=1800000ms  # 1800000 milliseconds
conf_load_balancing_load.balancing.driver.nginx.upstream_next_timeout=1d  # 1 day
  3. Make sure the properties file is owned by the 'apigee' user: 
    chown apigee:apigee /opt/apigee/customer/application/router.properties
  4. Restart the Router: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart

To set retry options, use the RetryOption property as described in virtual host configuration properties.