This section describes the HTTP load balancer plug-in. It includes the following topics:
The load balancer attempts to evenly distribute the workload among multiple Application Server instances (either stand-alone or clustered), thereby increasing the overall throughput of the system.
Using a load balancer also enables requests to fail over from one server instance to another. For HTTP session information to persist, configure HTTP session persistence. For more information, see Chapter 8, Configuring High Availability Session Persistence and Failover
For complete instructions on configuring load balancing, see the Sun Java System Application Server High Availability Administration Guide.
Use the asadmin tool, not the Admin Console, to configure HTTP load balancing.
See Also:
When a request first comes in from an HTTP client to the load balancer, it is a request for a new session. A request for a new session is called an unassigned request. The load balancer routes this request to an application server instance in the cluster according to a round-robin algorithm.
Once a session is created on an application server instance, the load balancer routes all subsequent requests for this session only to that particular instance. A request for an existing session is called an assigned or a sticky request.
The Sun Java System Application Server load balancer uses a sticky round robin algorithm to load balance incoming HTTP and HTTPS requests. All requests for a given session are sent to the same application server instance. With a sticky load balancer, the session data is cached on a single application server rather than being distributed to all instances in a cluster.
Therefore, the sticky round robin scheme provides significant performance benefits that normally override the benefits of a more evenly distributed load obtained with a pure round robin scheme.
When a new HTTP request is sent to the load balancer plug-in, it’s forwarded to an application server instance based on a simple round robin scheme. Subsequently, this request is “stuck” to this particular application server instance, either by using cookies, or explicit URL rewriting.
From the sticky information, the load balancer plug-in first determines the instance to which the request was previously forwarded. If that instance is found to be healthy, the load balancer plug-in forwards the request to that specific application server instance. Therefore, all requests for a given session are sent to the same application server instance.
The load balancer plug-in uses the following methods to determine session stickiness:
Cookie Method : the load balancer plug-in uses a separate cookie to record the route information. The HTTP client must support cookies to use the cookie based method.
Explicit URL Rewriting: the sticky information is appended to the URL. This method works even if the HTTP client does not support cookies.
The following directories contain sample applications that demonstrate load balancing and failover:
install_dir/samples/ee-samples/highavailability install_dir/samples/ee-samples/failover
The ee-samples directory also contains information for setting up your environment to run the samples.
This section describes how to set up the Load Balancer plug-in and includes the following sections:
Before configuring your load balancer, you must:
Install a web server.
Install the load balancer plug-in.
For information on the installation procedure, see the Sun Java System Application Server Installation Guide (if using the stand-alone Application Server) or the Sun Java Enterprise System Installation Guide (if using Java Enterprise System).
Configure the web server. For more information, see Configuring Web Servers for Load Balancing
Create Application Server clusters or server instances to participate in load balancing.
Deploy applications to these clusters or instances.
You can configure your load balancer in different ways, depending on your goals and environment, as described in the following sections:
The most common way to deploy the load balancer is with a cluster or clusters of server instances. By default all the instances in a cluster have the same configuration and the same applications deployed to them. The load balancer distributes the workload between the server instances and requests fail over from an unhealthy instance to a healthy one. If you’ve configured HTTP session persistence, session information persists when the request is failed over.
If you have multiple clusters, requests are only load balanced and failed over between the instances in a single cluster. Use multiple clusters in a load balancer to easily enable rolling upgrades of applications. For more information, see Upgrading Applications Without Loss of Availability.
You can also configure your load balancer to use stand-alone server instance instead of a cluster. This configuration results in the load balancer plug-in working as a reverse-proxy plug-in (sometimes called a pass-through plug-in). When the web server receives requests for applications enabled in the load balancer, it forwards the requests directly to the Application Server.
Use the same procedures to configure the load balancer for a pass-through plug-in as you use to configure it for a cluster of server instances.
It is also possible to configure your load balancer to use multiple stand-alone instances, and load balance and fail-over requests between them. However, in this configuration, you must manually ensure that the stand-alone instances have homogenous environments and the same applications deployed to them. Because clusters automatically maintain a homogenous environment, for most situations it is better and easier to use clusters.
Use the asadmin tool to configure load balancing in your environment. For more information on the asadmin commands used in these steps, see Configuring the Load Balancer
Create a load balancer configuration using the asadmin command create-http-lb-config.
Add a reference to a cluster or stand-alone server instance for the load balancer to manage using asadmin create-http-lb-ref.
If you created the load balancer configuration with a target, and that target is the only cluster or stand-alone server instance the load balancer references, skip this step.
Enable the cluster or stand-alone server instance referenced by the load balancer using asadmin enable-http-lb-server.
Enable applications for load balancing using asadmin enable-http-lb-application.
These applications must already be deployed and enabled for use on the clusters or stand-alone instances that the load balancer references. Enabling for load balancing is a separate step from enabling them for use.
Create a health checker using asadmin create-health-checker.
The health checker monitors unhealthy server instances so that when they become healthy again, the load balancer can send new requests to them.
Generate the load balancer configuration file using asadmin export-http-lb-config .
This command generates a configuration file to use with the load balancer plug-in shipped with the Sun Java System Application Server.
Copy the load balancer configuration file to your web server config directory where the load balancer plug-in configuration files are stored.
The load balancer plug-in installation program makes a few modifications to the web server’s configuration files. The changes made depend upon the web server.
The load balancer plug-in can be installed either along with Sun Java System Application Server Enterprise Edition, or separately, on a machine running the supported web server. For complete details on the installation procedure, see Chapter 1, Installing Application Server Software, in Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Installation Guide (if using the standalone Application Server) or Sun Java Enterprise System 2005Q5 Installation Guide (if using Java Enterprise System).
The installation program adds the following entries to the Sun Java System Web Server’s configuration files:
To the web server instance’s magnus.conf file, it adds:
##EE lb-pluginInit fn="load-modules" shlib="web_server_install_dir/plugins/lbplugin/bin/libpassthrough.so" funcs="init-passthrough,service-passthrough,name-trans-passthrough" Thread="no" Init fn="init-passthrough" ##end addition for EE lb-plugin
To the web server instance’s obj.conf file, it adds:
<Object name=default> NameTrans fn="name-trans-passthrough" name="lbplugin" config-file="web_server_install_dir/web_server_instance/config/loadbalancer.xml" <Object name="lbplugin"> ObjectType fn="force-type" type="magnus-internal/lbplugin" PathCheck fn="deny-existence" path="*/WEB-INF/*" Service type="magnus-internal/lbplugin" fn="service-passthrough" Error reason="Bad Gateway" fn="send-error" uri="$docroot/badgateway.html" </object>
In the above code, lbplugin is a name that uniquely identifies the Object, and web_server_install_dir/ web_server_instance/config/loadbalancer.xml is the location of the XML configuration file for the virtual server on which the load balancer is configured to run.
After installing, configure the load balancer as described in Setting Up HTTP Load Balancing
To use Apache Web Server, you must perform certain configuration steps before installing the load balancer plug-in. The load balancer plug-in installation also makes additional modifications to the Apache Web Server. After the plug-in is installed, you must perform additional configuration steps.
On Apache 1.3, when more than one Apache child processes runs, each process has its own load balancing round robin sequence. For example, if there are two Apache child processes running, and the load balancer plug-in load balances on to two application server instances, the first request is sent to instance #1 and the second request is also sent to instance #1. The third request is sent to instance #2 and the fourth request is sent to instance #2 again. This pattern is repeated (instance1, instance1, instance2, instance2, etc.)This behavior is different from what you might expect, that is, instance1, instance2, instance1, instance2, etc. In Sun Java System Application Server, the load balancer plug-in for Apache instantiates a load balancer instance for each Apache process, creating an independent load balancing sequence.
Apache 2.0 has multithreaded behavior if compiled with the --with-mpm=worker option.
For the Apache Web Server, your installation must meet the minimum requirements, depending on the version of Apache.
With Apache 1.3, the load balancer plug-in requires:
openssl-0.9.7e (source)
mod_ssl-2.8.16-1.3.x (source), where x represents the version of Apache. The mod_ssl version must match the Apache version.
gcc-3.3-sol9-sparc-local packages (for Solaris SPARC)
gcc-3.3-sol9-intel-local packages (for Solaris x86)
flex-2.5.4a-sol9-sparc-local packages (for Solaris SPARC)
flex-2.5.4a-sol9-intel-local packages (for Solaris x86)
The software sources are available at http://www.sunfreeware.com
In addition, before compiling Apache:
On the Linux platform, install Sun Java System Application Server on the same machine.
On the Solaris operating system, ensure that gcc version 3.3 and make are in the PATH, and flex is installed.
On the Solaris 10 operating system, before running make for OpenSSL, run mkheaders, located in /usr/local/lib/gcc-lib/sparc-sun-solaris2.9/3.3/install-tools on Solaris SPARC or /usr/local/lib/gcc-lib/i386-pc-solaris2.9/3.3/install-tools on Solaris x86.
If you are using gcc on Red Hat Enterprise Linux Advanced Server 2.1, the version must be later than gcc 3.0.
To use C compiler other than gcc, set the path of the C compiler and make utility in the PATH environment variable. For example, with the sh shell: export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:appserver_installdir/lib
With Apache 2.0, the load balancer plug-in requires:
openssl-0.9.7e (source)
httpd-2.0.49 (source)
gcc-3.3-sol9-sparc-local packages (for Solaris SPARC).
gcc-3.3-sol9-intel-local packages (for Solaris x86)
flex-2.5.4a-sol9-sparc-local packages (for Solaris SPARC)
flex-2.5.4a-sol9-intel-local packages (for Solaris x86)
The software sources are available at http://www.sunfreeware.com
In addition, before compiling Apache:
On the Linux platform, install Sun Java System Application Server on the same machine.
On the Solaris operating system, ensure that gcc version 3.3 and make are in the PATH, and flex is installed.
On the Solaris 10 operating system, before running make for OpenSSL, run mkheaders, located in /usr/local/lib/gcc-lib/sparc-sun-solaris2.9/3.3/install-tools on Solaris SPARC or /usr/local/lib/gcc-lib/i386-pc-solaris2.9/3.3/install-tools on Solaris x86.
If you are using gcc on Red Hat Enterprise Linux Advanced Server 2.1, the version must be later than gcc 3.0.
To use a C compiler other than gcc, set the path of the C compiler and make utility in the PATH environment variable. For example, with the sh shell:export LD_LIBRARY_PATH= app_server_install_dir/lib:$LD_LIBRARY_PATH.
Before installing the load balancer plug-in for Apache, install the Apache Web Server. The Apache source must be compiled and built to run with SSL. This section describes the minimum requirements and high-level steps needed to successfully compile Apache Web Server to run the load balancer plug-in. These requirements and steps only apply to the Solaris and Linux versions of the software. For information on the Windows version of Apache, see the Apache web site.
You must have already downloaded and uncompressed the Apache software.
Download and unpack the OpenSSL source.
Compile and build OpenSSL.
This step is not required on the Linux platform if OpenSSL 0.9.7.e is installed.
Enter these commands:
cd openssl-0.9.7e make make install |
For more information about OpenSSL, see the http://www.openssl.org/.
Follow one of these procedures, depending on the version of Apache:
For Apache 1.3, configure Apache with mod_ssl with the following steps:
Unpack the mod_ssl source.
cd mod_ssl-2.8.14–1.3.x
./configure –with-apache=../apache_1.3.x --with-ssl=../openssl-0.9.7e --prefix=install_path --enable-module=ssl --enable-shared=ssl --enable-rule=SHARED_CORE --enable-module=so
In the above commands, x is the Apache version number, and install_path is the directory in which to install Apache.
For more information on mod_ssl, see http://www.modssl.org.
For Apache 2.0, configure the source tree:
For Apache on Linux 2.1, before compiling:
Open src/MakeFile and find the end of the automatically generated section.
Add the following lines after the first four lines after the automatically generated section:
LIBS+= -licuuc -licui18n -lnspr4 -lpthread -lxerces-c -lsupport -lnsprwrap -lns-httpd40 LDFLAGS+= -L/appserver_installdir/lib -L/opt/sun/private/lib
Note that -L/opt/sun/private/lib is only required if you installed Application Server as part of a Java Enterprise System installation.
For example:
## (End of automatically generated section) ## CFLAGS=$(OPTIM) $(CFLAGS1) $(EXTRA_CFLAGS) LIBS=$(EXTRA_LIBS) $(LIBS1) INCLUDES=$(INCLUDES1) $(INCLUDES0) $(EXTRA_INCLUDES) LDFLAGS=$(LDFLAGS1) $(EXTRA_LDFLAGS) "LIBS+= -licuuc -licui18n -lnspr4 -lpthread -lxerces-c -lsupport -lnsprwrap -lns-httpd40 LDFLAGS+= -L/appserver_installdir /lib -L/opt/sun/private/lib
Set environment variable LD_LIBRARY_PATH.
With all installations, set it to: appserver_install_dir/lib
With Java Enterprise System Installations, set it to appserver_install_dir/lib:opt/sun/private/lib .
Compile Apache as described in the installation instructions for the version you are using.
For more information, see the http://httpd.apache.org/
In general the steps are:
Configure Apache for your environment.
The load balancer plug-in installation program extracts the necessary files to a directory in the web server’s root directory:
For Apache 1.3, the directory is libexec.
For Apache 2.0, the directory is modules .
It adds the following entries to the web server instance’s httpd.conf file:
<VirtualHost machine_name:443> ##Addition for EE lb-plugin LoadFile /usr/lib/libCstd.so.1 LoadModule apachelbplugin_module libexec/mod_loadbalancer.so #AddModule mod_apachelbplugin.cpp <IfModule mod_apachelbplugin.cpp> config-file webserver_instance/conf/loadbalancer.xml locale en </IfModule> <VirtualHost machine_ip_address> DocumentRoot "webserver_instance/htdocs" ServerName server_name </VirtualHost> ##END EE LB Plugin ParametersVersion 7
Apache Web Server must have the correct security files to work well with the load balancer plug-in.
Create a directory called sec_db_files under apache_install_dir.
Copy application_server_domain_dir /config/*.db to apache_install_dir /sec_db_files.
Depending on the platform, perform additional configuration.
On the Solaris platform:
Add the path /usr/lib/mps/secv1 to LD_LIBRARY_PATH in the apache_install_dir/bin/apachectl script. The path must be added before /usr/lib/mps.
On Linux:
Add the path /opt/sun/private/lib to LD_LIBRARY_PATH in the apache_install_dir/bin/apachectl script. The path must be added before /usr/lib.
On Microsoft Windows:
Add a new path to the Path environment variable.
Click Start->Settings->Control Panel->System->Advanced->Environment Variables->System Variables.
Add application_server_install_dir /bin to the Path environment variable.
Set the environment variable NSPR_NATIVE_THREADS_ONLY to 1.
In the Environment Variables window, under System Variables, click New. Enter Variable name of NSPR_NATIVE_THREADS_ONLY and Variable value of 1.
Restart the machine.
To configure Microsoft Internet Information Services (IIS) to use the load balancer plug-in, modify certain properties in Windows Internet Services Manager. The Internet Services Manager is located in the Administrative Tools folder in the Control Panel folder.
Make these modifications after installing the Sun Java System Application Server.
Open the Internet Services Manager.
Select the web site for which you want to enable the plug-in.
This web site is typically named the Default Web Site.
Right click on the web site and select Properties to open the Properties notebook.
Add a new ISAPI filter, following these steps:
Create and configure a new virtual directory:
Right click on the default web site, select New, and then Virtual Directory.
The Virtual Directory Creation Wizard opens.
In the Alias field, type sun-passthrough .
In the Directory field, type C:\Inetpub\wwwroot\sun-passthrough.
Check the Execute Permission checkbox.
Leave all other permission-related check boxes are left unchecked.
Click Finish.
Add the path of sun-passthrough.dll file and application_server_install_dir /bin to the system’s PATH environment variable.
Restart the machine.
Stop and start the web server for the new settings to take effect.
To stop the web server, right click on the web site and select Stop . To start the web server, right click on the web site and select Start.
Verify that the web server, load balancer plug-in, and Application Server are operating correctly.
Type the following in a web browser to access the web application context root: http://webserver_name/web_application, where webserver_name is the host name or IP address of the web server and web_application is the context root that you listed in the C:\Inetpub\wwwroot\sun-passthrough\sun-passthrough.properties file.
The installer automatically configures the following properties in sun-passthrough.properties. You can change the default values.
Property |
Definition |
Default Value |
---|---|---|
lb-config-file |
Path to the load balancer configuration file |
IIS_www_root\sun-passthrough\loadbalancer.xml |
log-file |
Path to the load balancer log file |
IIS_www_root\sun-passthrough\lb.log |
log-level |
Log level for the web server |
INFO |
The Sun Java System Application Server installer does not allow the installation of multiple load balancer plug-ins on a single machine. To have multiple web servers with the load balancer plug-in on a single machine, in either a single cluster or multiple clusters, a few manual steps are required to configure the load balancer plug-in.
Configure the new web server instance to use the load balancer plug-in.
Follow the steps in Modifications to Sun Java System Web Server or Using Apache Web Server , or Installation
Copy the DTD file.
Copy sun-loadbalancer_1_1.dtd from the existing web server instance’s config directory to the new instance’s config directory.
Set up the load balancer configuration file. Either:
Copy the existing load balancer configuration.
Use an existing load balancer configuration, copy the loadbalancer.xml file from the existing web server instance’s config directory to the new instance’s config directory.
Create a new load balancer configuration:
Use asadmin create-http-lb-config to create a new load balancer configuration.
Export the new configuration to a loadbalancer.xml file using asadmin export http-lb-config.
Copy that loadbalancer.xml file to the new web server’s config directory.
For information on creating a load balancer configuration and exporting it to a loadbalancer.xml file, see Creating an HTTP Load Balancer Configuration
A load balancer configuration is a named configuration in the domain.xml file. Load balancer configuration is extremely flexible:
Each load balancer configuration can have multiple load balancers associated with it, though each load balancer has only one load balancer configuration.
A load balancer services only one domain, though a domain can have multiple load balancers associated with it.
This section describes how to create, modify, and use a load balancer configuration, including the following topics:
Create a load balancer configuration using the asadmin command create-http-lb-config. Creating an HTTP Load Balancer Configuration describes the parameters. For more information see the documentation for create-http-lb-config, delete-http-lb-config, and list-http-lb-configs.
Table 4–1 Load Balancer Configuration Parameters
Parameter |
Description |
---|---|
response timeout |
Time in seconds within which a server instance must return a response. If no response is received within the time period, the server is considered unhealthy. The default is 60. |
Whether HTTPS requests to the load balancer result in HTTPS or HTTP requests to the server instance. For more information, see Configuring HTTPS Routing. |
|
reload interval |
Interval between checks for changes to the load balancer configuration file loadbalancer.xml. When the check detects changes, the configuration file is reloaded. A value of 0 disables reloading.For more information, see Enabling Dynamic Reconfiguration |
monitor |
Whether monitoring is enabled for the load balancer. |
Name of the cookie the load balancer plug-in uses to record the route information. The HTTP client must support cookies. If your browser is set to ask before storing a cookie, the name of the cookie is JROUTE. |
|
target |
Target for the load balancer configuration. If you specify a target, it is the same as adding a reference to it. Targets can be clusters or stand-alone instances. |
When you create a reference in the load balancer to a stand-alone server or cluster, the server or cluster is added to the list of target servers and clusters the load balancer controls. The referenced server or cluster still needs to be enabled (using enable-http-lb-server) before requests to it are load balanced. If you created the load balancer configuration with a target, that target is already added as a reference.
Create a reference using create-http-lb-ref. You must supply the load balancer configuration name and the target server instance or cluster.
To delete a reference, use delete-http-lb-ref. Before you can delete a reference, the referenced server or cluster must be disabled using disable-http-lb-server .
For more information, see the documentation for create-http-lb-ref and delete-http-lb-ref.
After creating a reference to the server instance or cluster, enable the server instance or cluster using enable-http-lb-server . If you used a server instance or cluster as the target when you created the load balancer configuration, you must enable it.
For more information, see the documentation for enable-http-lb-server .
All servers managed by a load balancer must have homogenous configurations, including the same set of applications deployed to them. Once an application is deployed and enabled for access (this happens during or after the deployment step) you must enable it for load balancing. If an application is not enabled for load balancing, requests to it are not load balanced and failed over, even if requests to the servers the application is deployed to are load balanced and failed over.
When enabling the application, specify the application name and target. If the load balancer manages multiple targets (for example, two clusters), enable the application on all targets.
For more information, see the online help for enable-http-lb-application .
If you deploy a new application, you must also enable it for load balancing and export the load balancer configuration again.
The load balancer’s health checker periodically checks all the configured Application Server instances that are marked as unhealthy. A health checker is not required, but if no health checker exists, or if the health checker is disabled, the periodic health check of unhealthy instances is not performed.
The load balancer’s health check mechanism communicates with the application server instance using HTTP. The health checker sends an HTTP request to the URL specified and waits for a response. A status code in the HTTP response header between 100 and 500 means the instance is healthy.
To create the health checker, use the asadmin create-http-health-checke r command. Specify the following parameters:
Table 4–2 Health Checker Parameters
Parameter |
Description |
Default |
---|---|---|
url |
Specifies the listener’s URL that the load balancer checks to determine its state of health. |
“/” |
interval |
Specifies the interval in seconds at which health checks of instances occur. Specifying 0 disables the health checker. |
30 seconds |
timeout |
Specifies the timeout interval in seconds within which a response must be obtained for a listener to be considered healthy. |
10 seconds |
If an application server instance is marked as unhealthy, the health checker polls the unhealthy instances to determine if the instance has become healthy. The health checker uses the specified URL to check all unhealthy application server instances to determine if they have returned to the healthy state.
If the health checker finds that an unhealthy instance has become healthy, that instance is added to the list of healthy instances.
For more information see the documentation for create-http-health-checker and delete-http-health-checker.
The health checker created by create-http-health-checker only checks unhealthy instances. To periodically check healthy instances set some additional properties in your exported loadbalancer.xml file.
These properties can only be set by manually editing loadbalancer.xml after you’ve exported it. There is no equivalent asadmin command to use.
To check healthy instances, set the following properties:
Table 4–3 Health-checker Manual Properties
Property |
Definition |
---|---|
True/false flag indicating whether to ping healthy server instances to determine whether they are healthy. To ping server instances, set the flag to true. |
|
Specifies how many times the load balancer’s health checker pings an unresponsive server instance before marking it unhealthy. Valid range is between 1 and 1000. A default value to set is 3. |
Set the properties by editing the loadbalancer.xml file. For example:
<property name="active-healthcheck-enabled" value="true"/> <property name="number-healthcheck-retries" value="3"/>
If you add these properties, then subsequently edit and export the loadbalancer.xml file again, you must add these properties to the file again, since the newly exported configuration won’t contain them.
The load balancer plug-in shipped with Sun Java System Application Server uses a configuration file called loadbalancer.xml. Use the asadmin tool to create a load balancer configuration in the domain.xml file. After configuring the load balancing environment, export it to a file.
Export a loadbalancer.xml file using the asadmin command export-http-lb-config.
Export the loadbalancer.xml file for a particular load balancer configuration. You can specify a path and a different file name. If you don’t specify a file name, the file is named loadbalancer.xml. load_balancer_config_name. If you don’t specify a path, the file is created in the application_server_install_dir /domains/domain_name /generated directory.
To specify a path on Windows, use quotes around the path. For example, "c:\sun\AppServer\loadbalancer.xml" .
Copy the exported load balancer configuration file to the web server’s configuration directory.
For example, for the Sun Java System Web Server, that location might be web_server_root/config .
The load balancer configuration file in the web server’s configuration directory must be named loadbalancer.xml. If your file has a different name, such as loadbalancer.xml. load_balancer_config_name, you must rename it.
If you change a load balancer configuration by creating or deleting references to servers, deploying new applications, enabling or disabling servers or applications, and so on, export the load balancer configuration file again and copy it to the web server’s config directory. For more information, see Exporting the Load Balancer Configuration File
The load balancer plug-in checks for an updated configuration periodically based on the reload interval specified in the load balancer configuration. After the specified amount of time, if the load balancer discovers a new configuration file, it starts using that configuration.
With dynamic reconfiguration, the load balancer plug-in periodically checks for an updated configuration.
To enable dynamic reconfiguration:
When creating a load balancer configuration, use the --reloadinterval option with asadmin create-http-lb-config .
This option sets the amount of time between checks for changes to the load balancer configuration file loadbalancer.xml. A value of 0 disables dynamic reconfiguration. By default, dynamic reconfiguration is enabled, with a reload interval of 60 seconds.
If you have previously disabled it, or to change the reload interval, use the asadmin set command.
After changing the reload interval, export the load balancer configuration file again and copy it to the web server’s config directory, then restart the web server.
If the load balancer encounters a hard disk read error while attempting to reconfigure itself, then it uses the configuration that is currently in memory. The load balancer also ensures that the modified configuration data is compliant with the DTD before over writing the existing configuration.
If a disk read error is encountered, a warning message is logged to the web server’s error log file.
The error log for Sun Java System Web Server’ is at: web_server_install_dir/webserver_instance /logs/.
Before stopping an application server for any reason, you want the instance to complete serving requests. The process of gracefully disabling a server instance or cluster is called quiescing.
The load balancer uses the following policy for quiescing application server instances:
If an instance (either stand-alone or part of a cluster) is disabled, and the timeout has not expired, sticky requests continue to be delivered to that instance. New requests, however, are not sent to the disabled instance.
When the timeout expires, the instance is disabled. All open connections from the load balancer to the instance are closed. The load balancer does not send any requests to this instance, even if all sessions sticking to this instance were not invalidated. Instead, the load balancer fails over sticky requests to another healthy instance.
Run asadmin disable-http-lb-server, setting the timeout (in minutes).
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the exported configuration to the web server config directory.
Stop the server instance or instances.
Before you undeploy a web application, you want to the application to complete serving requests. The process of gracefully disabling an application is called quiescing. When you quiesce an application, you specify a timeout period. Based on the timeout period, the load balancer uses the following policy for quiescing applications:
If the timeout has not expired, the load balancer does not forward new requests to the application, but returns them to the web server. However, the load balancer continues to forward sticky requests until the timeout expires.
When the timeout expires, the load balancer does not accept any requests for the application, including sticky requests.
When you disable an application from every server instance or cluster the load balancer references, the users of the disabled application experience loss of service until the application is enabled again. If you disable the application from one server instance or cluster while keeping it enabled in another server instance or cluster, users can still access the application.
Use asadmin disable-http-lb-application, specifying the following:
Timeout (in minutes).
Name of the application to disable.
Target cluster or instance on which to disable it.
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the exported configuration to the web server config directory.
The load balancer plug-in fails over HTTP/HTTPS sessions to another application server instance if the original application server instance to which the session was connected becomes unavailable. This section describes how to configure the load balancer plug-in to enable HTTP/HTTPS routing and session failover.
This section discusses the following topics:
The HTTP Secure (HTTPS) protocol uses Secure Sockets Layer (SSL) to provide encryption an decryption of HTTP requests for secure communication. For HTTPS routing to work, one or more HTTPS listeners must be configured.
The load balancer plug-in routes all incoming HTTP or HTTPS requests to application server instances. However, if HTTPS routing is enabled, an HTTPS request will be forwarded by the load balancer plug-in to the application server using an HTTPS port only. HTTPS routing is performed on both new and sticky requests.
If an HTTPS request is received and no session is in progress, then the load balancer plug-in selects an available application server instance with a configured HTTPS port, and forwards the request to that instance.
In an ongoing HTTP session, if a new HTTPS request for the same session is received, then the session and sticky information saved during the HTTP session is used to route the HTTPS request. The new HTTPS request is routed to the same server where the last HTTP request was served, but on the HTTPS port.
The httpsrouting option of the create-http-lb-config command controls whether HTTPS routing is turned on or off for all the application servers that are participating in load balancing. If this option is set to false, all HTTP and HTTPS requests are forwarded as HTTP. Set it to true when creating a new load balancer configuration, or change it later using the asadmin set command.
If https-routing is set to true, and a new or a sticky request comes in where there are no healthy HTTPS listeners in the cluster, then that request generates an error.
The Load Balancer has the following limitations with HTTP/HTTPS request processing.
If a session uses a combination of HTTP and HTTPS requests, then the first request must be an HTTP Request. If the first request is an HTTPS request, it cannot be followed by an HTTP request. This is because the cookie associated with the HTTPS session is not returned by the browser. The browser interprets the two different protocols as two different servers, and initiates a new session.
This limitation is valid only if httpsrouting is set to true .
If a session has a combination of HTTP and HTTPS requests, then the application server instance must be configured with both HTTP and HTTPS listeners.
This limitation is valid only if httpsrouting is set to true.
If a session has a combination of HTTP and HTTPS requests, then the application server instance must be configured with HTTP and HTTPS listeners that use standard port numbers, that is, 80 for HTTP, and 443 for HTTPS. This limitation applies regardless of the value set for httpsrouting.
An idempotent request is one that does not cause any change or inconsistency in an application when retried. In HTTP, some methods (such as GET) are idempotent, while other methods (such as POST) are not. Retrying an idempotent URL must not cause values to change on the server or in the database. The only difference is a change in the response received by the user.
Examples of idempotent requests include search engine queries and database queries. The underlying principle is that the retry does not cause an update or modification of data.
To enhance the availability of deployed applications, configure the environment to retry failed idempotent HTTP requests on all the application server instances serviced by a load balancer. This option is used for read-only requests, for example, to retry a search request.
Configure idempotent URLs in the sun-web.xml file. When you export the load balancer configuration, idempotent URL information is automatically added to the loadbalancer.xml file.
For more information on configuring idempotent URLs, see Configuring Idempotent URL Requests in Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Developer’s Guide.
Upgrading an application to a new version without loss of availability to users is called a rolling upgrade. Carefully managing the two versions of the application across the upgrade ensures that current users of the application complete their tasks without interruption, while new users transparently get the new version of the application. With a rolling upgrade, users are unaware that the upgrade occurs.
Rolling upgrades pose varying degrees of difficulty depending on the magnitude of changes between the two application versions.
If the changes are superficial, for example, changes to static text and images, the two versions of the application are compatible and can both run at once in the same cluster. Compatible applications must:
Use the same session information
Use compatible database schemas
Have generally compatible application-level business logic
Use the same physical data source
You can perform a rolling upgrade of a compatible application in either a single cluster or multiple clusters. For more information, see Upgrading In a Single Cluster
If the two versions of an application do not meet all the above criteria, then the applications are considered incompatible. Executing incompatible versions of an application in one cluster can corrupt application data and cause session failover to not function correctly. The problems depend on the type and extent of the incompatibility. It is good practice to upgrade an incompatible application by creating a “shadow cluster” to which to deploy the new version and slowly quiesce the old cluster and application. For more information, see Upgrading Incompatible Applications
The application developer and administrator are the best people to determine whether application versions are compatible. If in doubt, assume that the versions are incompatible, since this is the safest approach.
You can perform a rolling upgrade of an application deployed to a single cluster, providing the cluster’s configuration is not shared with any other cluster.
Save an old version of the application or back up the domain.
To back up the domain use the asadmin backup-domain command.
Turn off dynamic reconfiguration (if enabled) for the cluster.
To do this with Admin Console:
Expand the Configurations node.
Click the name of the cluster’s configuration.
On the Configuration System Properties page, uncheck the Dynamic Reconfiguration Enabled box.
Click Save
Alternatively, use this command:
asadmin set --user user --passwordfile password_file cluster_name -config.dynamic-reconfiguration-enabled=false
Redeploy the upgraded application to the target domain.
If you redeploy using the Admin Console, the domain is automatically the target. If you use asadmin, specify the target domain. Because dynamic reconfiguration is disabled, the old application continues to run on the cluster.
Enable the redeployed application for the instances using asadmin enable-http-lb-application.
Quiesce one server instance in the cluster from the load balancer.
Follow these steps:
Disable the server instance using asadmin disable-http-lb-server.
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the exported configuration file to the web server instance’s configuration directory.
For example, for Sun Java System Web Server, the location is web_server_install_dir/ https- host-name /config/loadbalancer.xml . To ensure that the load balancer loads the new configuration file, be sure that dynamic reconfiguration is enabled by setting the reloadinterval in the load balancer configuration.
Wait until the timeout has expired.
Monitor the load balancer’s log file to make sure the instance is offline. If users see a retry URL, skip the quiescing period and restart the server immediately.
Restart the disabled server instance while the other instances in the cluster are still running.
Restarting causes the server to synchronize with the domain and update the application.
Test the application on the restarted server to make sure it runs correctly.
Re-enable the server instance in load balancer.
Follow these steps:
Enable the server instance using asadmin enable-http-lb-server.
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the configuration file to the web server’s configuration directory as described in Upgrading In a Single Cluster of Upgrading In a Single Cluster .
Repeat steps 5 through 8 for each instance in the cluster.
When all server instances have the new application and are running, you can re-enable dynamic reconfiguration for the cluster again.
Save an old version of the application or back up the domain.
To back up the domain use the asadmin backup-domain command.
Turn off dynamic reconfiguration (if enabled) for all clusters.
To do this with Admin Console:
Expand the Configurations node.
Click the name of one cluster’s configuration.
On the Configuration System Properties page, uncheck the Dynamic Reconfiguration Enabled box.
Click Save
Repeat for the other clusters
Alternatively, use this command:
asadmin set --user user --passwordfile password_file cluster_name-config.dynamic-reconfiguration-enabled=false
Redeploy the upgraded application to the target domain.
If you redeploy using the Admin Console, the domain is automatically the target. If you use asadmin, specify the target domain. Because dynamic reconfiguration is disabled, the old application continues to run on the clusters.
Enable the redeployed application for the clusters using asadmin enable-http-lb-application.
Quiesce one cluster from the load balancer
Disable the cluster using asadmin disable-http-lb-server.
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the exported configuration file to the web server instance’s configuration directory.
For example, for Sun Java System Web Server, the location is web_server_install_dir/ https- host-name /config/loadbalancer.xml . Dynamic reconfiguration must be enabled for the load balancer (by setting the reloadinterval in the load balancer configuration), so that the new load balancer configuration file is loaded automatically.
Wait until the timeout has expired.
Monitor the load balancer’s log file to make sure the instance is offline. If users see a retry URL, skip the quiescing period and restart the server immediately.
Restart the disabled cluster while the other clusters are still running.
Restarting causes the cluster to synchronize with the domain and update the application.
Test the application on the restarted cluster to make sure it runs correctly.
Re-enable the cluster in load balancer:
Repeat steps 5 through 8 for the other clusters.
When all server instances have the new application and are running, you can reenable dynamic reconfiguration for all clusters again.
For information on what makes applications compatible, see Application Compatibility the new version of the application is incompatible with the old. Also, you must upgrade incompatible application in two or more clusters. If you have only one cluster, create a “shadow cluster” for the upgrade, as described below.
When upgrading an incompatible application:
Give the new version of the application a different name from the old version of the application. The steps below assume that the application is renamed.
If the data schemas are incompatible, use different physical data sources after planning for data migration.
Deploy the new version to a different cluster from the cluster where the old version is deployed.
Set an appropriately long timeout for the cluster running the old application before you take it offline, because the requests for the application won’t fail over to the new cluster. These user sessions will simply fail.
Save an old version of the application or back up the domain.
To back up the domain use the asadmin backup-domain command.
Create a “shadow cluster” on the same or a different set of machines as the existing cluster.
Use the Admin Console to create the new cluster and reference the existing cluster’s named configuration.
Customize the ports for the new instances on each machine to avoid conflict with existing active ports.
For all resources associated with the cluster, add a resource reference to the newly created cluster using asadmin create-resource-ref.
Create a reference to all other applications deployed to the cluster (except the current redeployed application) from the newly created cluster using asadmin create-application-ref.
Configure the cluster to be highly available using asadmin configure-ha-cluster.
Create reference to the newly-created cluster in the load balancer configuration file using asadmin create-http-lb-ref.
Give the new version of application a different name from the old version.
Deploy the new application with the new cluster as the target. Use a different context root or roots.
Enable the deployed new application for the clusters using asadmin enable-http-lb-application.
Start the new cluster while the other cluster is still running.
The start causes the cluster to synchronize with the domain and be updated with the new application.
Test the application on the new cluster to make sure it runs correctly.
Disable the old cluster from the load balancer using asadmin disable-http-lb-server.
Set a timeout for how long lingering sessions survive.
Enable the new cluster from the load balancer using asadmin enable-http-lb-server.
Export the load balancer configuration file using asadmin export-http-lb-config.
Copy the exported configuration file to the web server instance’s configuration directory.
For example, for Sun Java System Web Server, the location is web_server_install_dir/ https- host-name /config/loadbalancer.xml . Dynamic reconfiguration must be enabled for the load balancer (by setting the reloadinterval in the load balancer configuration), so that the new load balancer configuration file is loaded automatically.
After the timeout period expires or after all users of the old application have exited, stop the old cluster and delete the old application.
The load balancer plug-in uses the web server’s logging mechanism to write log messages. The default log level on the Application Server is set to the default logging level on Sun Java System Web Server (INFO), Apache Web Server (WARN) and Microsoft IIS (INFO). The application server log levels - FINE, FINER, and FINEST map to the DEBUG level on the web server.
These log messages are written to the web server log files, and are in the form of raw data that can be parsed using scripts, or imported into spreadsheets to calculate required metrics.
The load balancer plug-in generates the following types of log messages:
These messages will be logged when you are using idempotent URLs and error page settings.
An output for idempotent URL pattern configuration contains the following information:
When the log level is set to FINE:
CONFxxxx: IdempotentUrlPattern configured <url-pattern> <no-of-retries> for web-module : <web-module>
When the log level is set to SEVERE:
CONFxxxx: Duplicate entry of Idempotent URL element <url-pattern> for webModule <web-module> in loadbalancer.xml."
When the log level is set to WARN:
CONFxxxx: Invalid IdempotentUrlPatternData <url-pattern> for web-module <web-module>
An output for error page URL configuration contains the following information (log level set to WARN):
CONFxxxx: Invalid error-url for web-module <web-module>
These log messages are generated while a request is being load balanced and dispatched.
An output for standard logging for each method start contains the following information (log level set to FINE):
ROUTxxxx: Executing Router method <method_name>
An output for router logs for each method start contains the following information (log level set to INFO):
ROUTxxxx: Successfully Selected another ServerInstance for idempotent request <Request-URL>
An output for runtime logs contains the following information (log level set to INFO):
RNTMxxxx: Retrying Idempotent <GET/POST/HEAD> Request <Request-URL>
These errors appear if there are configuration problems, for example, if the custom error page referenced is missing.
Log level set to INFO:
ROUTxxxx: Non Idempotent Request <Request-URL> cannot be retried
For example: ROUTxxxx: Non Idempotent Request http://sun.com/addToDB?x=11&abc=2 cannot be retried
Log level set to FINE:
RNTMxxxx: Invalid / Missing Custom error-url / page: <error-url> for web-module: <web-module>
For example: RNTMxxxx: Invalid / Missing Custom error-url / page: myerror1xyz for web-module: test
The load balancer plug-in logs the following information:
Request start/stop information for every request.
Failed-over request information when the request fails over from an unhealthy instance to a healthy instance.
List of unhealthy instances at the end of every health check cycle.
When load balancer logging is enabled, and if the web server logging level is set to DEBUG or to print verbose messages, the load balancer writes HTTP session IDs in the web server log files. Therefore, if the web server hosting the load balancer plug-in is in the DMZ, do not use the DEBUG or similar log level in production environments.
If you must use the DEBUG logging level, turn off load balancer logging by setting require-monitor-data property to false in loadbalancer.xml.
Set the logging options in the web server. The procedure depends on the web server:
Set the load balancer configuration’s monitor option to true.
Use the asadmin create-http-lb-config command to set monitoring to true when you initially create the load balancer configuration, or use the asadmin set command to set it to true later. Monitoring is disabled by default.
The format of the load balancer plug-in log messages is as follows.
The start of an HTTP request contains the following information:
RequestStart Sticky(New) <req-id> <time-stamp> <URL>
The timestamp value is the number of milliseconds from January 1, 1970. For example:
RequestStart New 123456 602983 http://austen.sun.com/Webapps-simple/servlet/Example1
The end of an HTTP request contains the RequestExit message, as follows:
RequestExit Sticky(New) <req-id> <time-stamp> <URL> <listener-id> <response-time> Failure-<reason for error>(incase of a failure)
For example:
RequestExit New 123456 603001 http://austen.sun.com/Webapps-simple/servlet/Example1 http://austen:2222 18
In the RequestExit message, <response-time> indicates the total request turn-around time in milliseconds, from the perspective of the load balancer plug-in.
The list of unhealthy instances, as follows:
UnhealthyInstances <cluster-id> <time-stamp> <listener-id>, <listener-id>...
For example:
UnhealthyInstances cluster1 701923 http://austen:2210, http://austen:3010
A list of failed-over requests, as follows:
FailedoverRequest <req-id> <time-stamp> <URL> <session-id> <failed-over-listener-id> <unhealthy-listener-id>
For example:
FailedoverRequest 239496 705623 http://austen.sun.com/Apps/servlet/SessionTest 16dfdac3c7e80a40 http://austen:4044 http://austen:4045