In WSO2 products based on Carbon 4.4.0 or later versions, you have the option of setting the required tenant loading policy by enabling either Lazy Loading or Eager Loading of tenants. Additionally, you can separately control the loading policy for web applications and axis2 services deployed in your tenants using the GhostDeployment setting.
By default, Lazy Loading is enabled for tenants in all WSO2 products.
First, read the following descriptions to understand how Lazy loading and Eager loading work:
- Lazy Loading: Lazy loading of tenants ensures that all tenants are not loaded at the time the server starts. Instead Instead, the tenants are loaded only when on demand (upon a request is made sent to a particular tenant. By default, lazy loading is enabled for tenants in all WSO2 products, but not for some artifacts (). When a tenant receives a request, the particular tenant and all tenant-specific artifacts except web applications and axis2 services) deployed for your tenants. Therefore get loaded. Therefore, if you have these artifacts (web applications and axis2 services) deployed in your tenants, you will need to separately enable lazy loading for artifacts using the using the
GhostDeploymentsetting. See Configuring Lazy Loading for instructions.
If If lazy loading is not enabled for artifacts, by default, these artifacts will comply with the Eager loading behavior that is explained below.
Tenants (including the tenant-specific artifacts) are unloaded from memory if the tenant remains idle for a specified amount of time. You can configure the allowed tenant idle time. See Configuring Lazy Loading for instructions.
- Eager Loading: Unlike lazy loading, eager loading ensures that tenants will be initialized when the server starts (without any delays). As explained above, Lazy loading is the default tenant loading policy in WSO2 products, and you You can switch to Eager loading if required. Note that you also have the option of enabling Eager loading for specific tenants so that only the required tenants will be loaded when the server starts. If you have web applications and axis2 services deployed for your tenants, you will want these artifacts to behave according to the Eager loading policy. Therefore, it is recommended that you disable lazy loading for artifacts when Eager loading is enabled. See Configuring Eager Loading for instructions.
When eager loading is enabled, tenants (and the tenant-specific artifacts) are expected to remain in memory without unloading until the server shuts down. However, due to a known issue in the system, tenants (and the tenant-specific artifacts) will unload from the system if the tenants are idle for more than 30 minutes. You can overcome this condition by applying a system property to change the allowed tenant idle time. See Configuring Eager Loading for instructions.
Now, see the instructions given below to configure the required tenant loading policy for your system.
As explained above, Lazy Loading (for tenants) is enabled as the loading policy in WSO2 products, by default. To verify that Lazy loading is enabled, open the carbon.xml file xml file (stored in the in the
<PRODUCT_HOME>/repository/conf directory) and see that see that
<LazyLoading> is uncommented is uncommented as shown below.
<Tenant> <LoadingPolicy> <LazyLoading> <IdleTime>30</IdleTime> </LazyLoading> <!--<EagerLoading> <Include>*,!foo.com,!bar.com</Include> </EagerLoading>--> </LoadingPolicy> </Tenant>
- Specify the tenant idle time when you configure the tenant loading policy:
- Be sure that the
<LazyLoading>element is enabled and
<EagerLoading>is commented out as per the default setting.
Set the tenant idle time using the
<IdleTime>element as shown below.
<Tenant> <LoadingPolicy> <LazyLoading> <IdleTime>30</IdleTime> </LazyLoading>--> <!--<EagerLoading> <Include>*,!foo.com,!bar.com</Include> </EagerLoading>--> </LoadingPolicy> </Tenant>
Alternatively, you can specify the tenant idle time when you start the server:
- Open the product startup script (.
/wso2server.shfile for Linux and
wso2server.batfor Windows), which is stored in the in the
Add the following system property.
JAVA$JAVA_OPTS \ -Dtenant.idle.time=30<value_in_minutes. \
Restart the server.
- Open the product startup script (.
Configuring Eager Loading
Follow the instructions given below to change the tenant loading policy to eager loading and to change the tenant idle time.
Enabling eager loading for tenants
|Before you enable eager loading, note the following:|
carbon.xmlfile from the
<EagerLoading>element and comment out
<LazyLoading>as shown below.
<Tenant> <LoadingPolicy> <!--<LazyLoading> <IdleTime>30</IdleTime> </LazyLoading>--> <EagerLoading> <Include>*,!foo.com,!bar.com</Include> </EagerLoading> </LoadingPolicy> </Tenant>
- You can then list the specific tenant domains to which eager loading should apply, by using the
<Include>element. See the following examples:
Configuring the tenant unloading time (for eager loading)
Due to a known issue, when eager loading is enabled, tenants will be unloaded from memory if the tenant remains idle for more than 30 minutes. This issues will be resolved in the Carbon 4.5.0 release. In current product releases, you have the option of changing the allowed idle time (which is 30 minutes, by default) using a system property: