The Load-balanced EndpointGroup distributes the messages (load) arriving at it among a set of listed endpoints or or static members by evaluating the load balancing policy and any other relevant parameters.
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
XML Configuration
| Info | ||
|---|---|---|
| ||
You can configure the Load-balance endpoint using XML. Click on the "Switch to source view" link in the "Load Balance Group" page.
|
The syntax of the load balance endpoint is as follows.
| Code Block | ||
|---|---|---|
| ||
<session type="http|simpleClientSession"/>?
<loadBalance [policy="roundRobin"] [algorithm="impl of org.apache.synapse.endpoints.algorithms.LoadbalanceAlgorithm"]
[failover="true|false"]>
<endpoint .../>+
<member hostName="host" [httpPort="port"] [httpsPort="port2"]>+
</loadBalance>
|
...
- The
failoverattribute mentioned above is not applicable for session affinity based endpoints and it is always considered as set to false. If it is required to have failover behavior in session affinity based load balance endpoints, list failover endpoints as the target endpoints.
UI Configuration
1. In the "Add Endpoint" list, click "Load Balance Group Endpoint" (See Adding an Endpoint). The "Load Balance Group Endpoint" page appears.
The following fields are specific to the Load Balance Group Endpoint:
...
The following page is opened by clicking Load-balance Endpoint in the Add Endpoint tab of the Manage Endpoints page.
The parameters available to configure a load-balance endpoint are as follows.
| Parameter Name | Description |
|---|---|
| Endpoint Name | This parameter is used to enter a unique name for the endpoint. |
| Algorithm | The algorithm on which the load balancing is based. Round Robin is the default algorithm. You can also load a custom algorithm. Instructions for creating a custom algorithm are included in this article. |
| Session Management | A session management method from the load balancing group. The possible values are |
...
as follows.
|
...
|
...
|
...
|
...
|
| Session Timeout ( |
...
2. Click "Add Endpoint."
3. A shortcut menu with the available endpoints appears.
4. Click on the endpoint you want to add as a Load Balance Group Endpoint. A tab with the fields relevant to the selected endpoint appears.
| Mills) | The number of milliseconds after which the session would time out. |
| Add Child | Click this link to add a child endpoint. The required endpoint type can be selected from the list and a section displaying parameters relevant to the selected endpoint type will appear. You can add as many endpoints as required to the load-balance group. See the details of child endpoints |
...
| in Address Endpoint, WSDL Endpoint, and Failover Group. |
...
| title | Tip |
|---|
| Add Property | Click this link to add properties to the load-balance endpoint. See Properties Reference for details of the available properties. |
| Excerpt | ||
|---|---|---|
| ||
Description of the Load-balance Endpoint in WSO2 ESB. |