Versions Compared

Old Version 50

changes.mady.by.user Former user

Saved on

compared with

New Version 51

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

  • Lazy Loading: Lazy loading of tenants ensures that all tenants are not loaded at the time the server starts. Instead, the tenants are loaded on demand (upon a request sent to a particular tenant). When a tenant receives a request, the particular tenant and all tenant-specific artifacts, except web applications and axis2 services , 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 GhostDeployment setting. 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). You can switch to Eager loading if eager loading if required. Note that you also have the option of enabling Eager 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 eager loading policy. Therefore, it is recommended that you disable lazy loading for artifacts (GhostDeployment setting) when Eager eager loading is enabled. 

    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  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 lazy loading is enabled, open the carbon.xml file (stored in the <PRODUCT_HOME>/repository/conf directory) and see that <LazyLoading> is uncommented as shown below.

...

Configuring the tenant unloading time (for Lazy Loading) 

If you have Lazy loading enabled, you can configure the allowed tenant idle time. For example, if you set the idle time to 30 minutes, tenants that are idle for more than 30 minutes will be unloaded automatically in your system. You can configure this value using two methods.

  • Specify the tenant idle time when you configure the tenant loading policy:

    1. Open the carbon.xml file. 

    2. Be sure that the <LazyLoading> element is enabled and <EagerLoading> is commented out as per the default setting.

    3. Set the tenant idle time using the <IdleTime> element as shown below.

      Code Block
      <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:

    1. Open the product startup script (./wso2server.sh file for Linux and wso2server.bat for Windows), which is stored in the <PRODUCT_HOME>/bin directory.

    2. Add the following system property.

      Code Block
      $JAVA_OPTS \ 
     -Dtenant.idle.time=<value_in_minutesminutes>. \

    3. Restart the server.

Configuring Eager Loading

Follow the instructions given below to change the tenant loading policy to eager loading and to change the tenant idle time.

Note
Before you enable eager loading, note the following:
  • Web applications and axis2 services that are deployed as artifacts in your tenants follow the eager loading behavior by default unless the GhostDeployment setting is enabled, as explained above under Enabling lazy loading of artifacts. Therefore, when you enable eager loading for your tenants, make sure that GhostDeployment is disabled.
  • The server startup time may increase depending on the number of tenants and artifacts you have.
  • The server's memory footprint will increase depending on the number of tenants and artifacts that are loaded.

...