Load Balancing / High Availability options:
This is list of options inside Load Balancing / High Availability in Data Sources.
These options are inside given data source configuration file. For example: postgresTest-source_1.conf. The filename depends on the name of the data source → nameOfDataSource.conf.
⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!
| Key | Requirements | Conf File field | Description | Possible values | Default |
|---|---|---|---|---|---|
| Enable load balancing | - (Unlocks this section) | useLoadBalancing | Option must be selected for Load Balancing to work. The jdbc URL specified in the top section of the configuration will be ignored, although used as the initially configured server in the load balancing configuration. | Boolean | false |
| Track cluster changes | MySQL, MS-SQL, and Postgres | trackClusterChanges | Track the cluster state and adjust the LB pool accordingly | Boolean | false |
| Target write capacity | track cluster changes | desiredWriteCapacity | Desired write capacity for writable nodes | Integer | - |
| Target read capacity | track cluster changes | desiredReadCapacity | Desired read capacity for writable nodes | Integer | - |
| Use response metric | - | useResponseMetrics | Use response time metrics for load balancing decisions to find nearest readers | Boolean | false |
| Response Metric Multiplier | Use response metric | responseMetricMultiplier | How much slower a reader can be vs. the fastest reader and still be eligible for reads | Float | 2 |
| Track Replication Lags | - | trackReplicationLags | Estimate the replication lag between nodes. Used to improve read/write split behavior. Do not use with forced replication delays. | Boolean | false |
| Alert threshold (ms) | Track Replication Lags | alertThreshold | If average lag detected is greater than this value an alert will be generated. There may be a greater-than-usual lag detected at the proxy start. Set to 0 to disable. | Long | 0 (disabled) |
| Failover Script | - | failoverScript | Script to be run when failure is detected, place in heimdall install directory | String | - |
| Name | - | servers.name | Name of the server | String | - |
| Url | - | servers.url | JDBC Url to connect to the server | String | - |
| Enabled | - | enabled | Disables/Enables the given server - if disabled while active, connections will be migrated to a new server if available | Boolean | true |
| Writeable | - | writeable | If unchecked (false), only use if the reader eligible rule matches for a query | Boolean | false |
| ( active ) | inside conf. file only | active | Status of the server | Boolean | - |
| ( failed ) | inside conf. file only | failed | Status of the server | Boolean | - |