Table of Contents
db_url (string)db_table (string)probing_interval (integer)probing_method (string)probing_from (string)probing_reply_codes (string)probing_verbose (number)lb_define_blacklist (string)fetch_freeswitch_stats (integer)initial_freeswitch_load (integer)cluster_id (integer)cluster_sharing_tag (string)lb_start(grp,resources[,flags],[attrs])
lb_next([attrs])
lb_start_or_next(grp,resources[,flags],[attrs])
load_balance(grp,resources[,flags],[attrs])
lb_reset()
lb_is_started()
lb_disable_dst()
lb_is_destination(ip,port,[group],[active],[attrs]])
lb_count_call(ip,port,grp,resources[,undo])
List of Tables
List of Examples
db_url parameterdb_table parameterprobing_interval parameterprobing_method parameterprobing_from parameterprobing_reply_codes parameterprobing_verbose parameterlb_define_blacklist parameterfetch_freeswitch_load parameterinitial_freeswitch_load parametercluster_id parametercluster_sharing_tag parameterlb_start usagelb_next() usagelb_next() usagelb_disable_dst() usagelb_is_destination usagelb_count_call usagelb_list usagelb_status usageThe Load-Balancer module comes to provide traffic routing based on load. Shortly, when OpenSIPS routes calls to a set of destinations, it is able to keep the load status (as number of ongoing calls) of each destination and to choose to route to the less loaded destination (at that moment). OpenSIPS is aware of the capacity of each destination - it is preconfigured with the maximum load accepted by the destinations. To be more precise, when routing, OpenSIPS will consider the less loaded destination not the destination with the smallest number of ongoing calls, but the destination with the largest available slot.
Also the module has the capability to do failover (to try a new destination if the selected one done not responde), to keep state of the destinations (to remember the failed destination and avoid using them agai) and to check the health of the destination (by doing probing of the destination and auto re-enabling).
Please refer to the Load-Balancer tutorial from the OpenSIPS website: https://opensips.org/Documentation/Tutorials-LoadBalancing-1-9.
The module has the capability to monitor the status of the destinations by doing SIP probing (sending SIP requests like OPTIONS).
For each destination, you can configure what kind of probing should be done (probe_mode column):
(0) - no probing at all;
(1) - probing only when the destination is in disabled mode (disabling via MI command will competely stop the probing also). The destination will be automatically re-enabled when the probing will succeed next time;
(2) - probing all the time. If disabled, the destination will be automatically re-enabled when the probing will succeed next time;
A destination can become disabled in two ways:
The following modules must be loaded before this module:
Dialog - Dialog module
freeswitch. - only if "fetch_freeswitch_stats" is enabled.
dialog - TM module (only if probing is enabled)
clusterer - only if "cluster_id" option is enabled.
database - one of the DB modules
The URL pointing to the database where the load-balancing rules are stored.
Default value is “mysql://opensips:opensipsrw@localhost/opensips”.
Example 1.1. Set db_url parameter
...
modparam("load_balancer", "db_url", "dbdriver://username:password@dbhost/dbname")
...
The name of the DB table containing the load-balancing rules.
Default value is “load_balancer”.
How often (in seconds) the probing of a destination should be done. If set to 0, the probing will be disabled as functionality (for all destinations)
Default value is “30”.
Example 1.3. Set probing_interval parameter
...
modparam("load_balancer", "probing_interval", 60)
...
The SIP method to be used for the probing requests.
Default value is “"OPTIONS"”.
Example 1.4. Set probing_method parameter
...
modparam("load_balancer", "probing_method", "INFO")
...
The FROM SIP URI to be advertised in the SIP probing requests.
Default value is “"sip:prober@localhost"”.
Example 1.5. Set probing_from parameter
...
modparam("load_balancer", "probing_from", "sip:pinger@192.168.2.10")
...
A comma separted list of SIP reply codes. The codes defined here will be considered as valid reply codes for probing messages, apart for 200.
Default value is “NULL”.
Example 1.6. Set probing_reply_codes parameter
...
modparam("load_balancer", "probing_reply_codes", "501, 403")
...
A boolean option to enable extra logging related to the enabling or disabling of the destinations based on probing replies and MI commands.
A 0 value means disabled, anything else means enabled.
The extra logging will be done on INFO level.
Default value is “0” (disabled).
Defines a blacklist based on a lb group. This list will contain the IPs (no port, all protocols) of the destinations matching the given group.
Multiple instances of this param are allowed.
Default value is “NULL”.
Example 1.8. Set the lb_define_blacklist parameter
...
modparam("load_balancer", "lb_define_blacklist", "list= 1,4,3")
modparam("load_balancer", "lb_define_blacklist", "blist2= 2,10,6")
...
If enabled, the maximum value of a resource may also consist of FreeSWITCH Event Socket Layer URLs, e.g. "channels=fs://:password@freeswitch.example.com" or "channels=fs://user:password@127.0.0.1:8021". The default ESL port is 8021.
OpenSIPS will establish a connection with the given socket and periodically update the internal maximum value of the given resource using statistics pushed by the FreeSWITCH box.
The max value of a resource is updated every event_heartbeat_interval seconds (see the "freeswitch" OpenSIPS module for more details regarding this setting), as the stats arrive from FreeSWITCH.
Given the following format for FreeSWITCH heartbeat messages:
{
...
"FreeSWITCH-Hostname": "pbx2",
"FreeSWITCH-IPv4": "172.17.0.3",
"Idle-CPU": "78.400000",
"Max-Sessions": "1000",
"Session-Count": "0",
...
}
, the load balancer uses the following formula in order to periodically update its "max_load" values for each FreeSWITCH box (FreeSWITCH data is highlighted in bold):
max_load = (Idle-CPU / 100) * (Max-Sessions - (Session-Count - current_load))
Default value is “0” (disabled).
Example 1.9. Set the fetch_freeswitch_load parameter
...
modparam("load_balancer", "fetch_freeswitch_stats", 1)
...
This parameter is only relevant for some seconds after module startup/reload, when no statistics from newly loaded FreeSWITCH ESL sockets have arrived, yet the routing of calls must remain unaffected. Any FreeSWITCH-enabled resource will inherit this value for the entire interval mentioned above (up to 20 seconds!).
Default value is “1000”.
Example 1.10. Set the initial_freeswitch_load parameter
...
modparam("load_balancer", "initial_freeswitch_load", 200)
...
The ID of the cluster the module is part of. The clustering support is used in load-balancer module for two purposes: for sharing the status of the destinations and for controlling the pinging to destinations.
If clustering enbled, the module will automatically share changes over the status of the destinations with the other OpenSIPS instances that are part of a cluster. Whenever such a status changes (following an MI command, a probing result, a script command), the module will replicate this status change to all the nodes in this given cluster.
The clustering with sharing tag support may be used to control which node in the cluster will perform the pinging/probing to destinations. See the cluster_sharing_tag option.
For more info on how to define and populate a cluster (with OpenSIPS nodes) see the "clusterer" module.
Default value is “0 (none)”.
Example 1.11. Set cluster_id parameter
...
# replicate destination status with all OpenSIPS in cluster ID 9
modparam("load_balancer", "cluster_id", 9)
...
The name of the sharing tag (as defined per clusterer modules) to control which node is responsible for perform the self-triggered actions in the module. Such actions may be the destination probing or sharing the changes in the destination status. If defined, only the node with active status of this tag will perform the actions (pinging and sharing status).
The cluster_id must be defined for this option to work.
This is an optional parameter. If not set, all the nodes in the cluster will individually do the probing and share the status changes.
Default value is “empty (none)”.
Example 1.12. Set cluster_sharing_tag parameter
...
# only the node with the active "vip" sharing tag will perform pinging
# and broadcast the status changes
modparam("load_balancer", "cluster_id", 9)
modparam("load_balancer", "cluster_sharing_tag", "vip")
...
The function starts a new load-balancing session over the available destinations. This translates into finding the less loaded destination that can provide the requested resources and belong to a requested group.
Meaning of the parameters is as follows:
grp (int) - group id for the destinations; the destination may be grouped in several groups you can you for differnet scenarios.
resources (string) - a semi-colon separated list of resources required by the current call.
flags (string, optional) - various flags to controll the LB algorithm ( or computing the available load on the system):
n - Negative availability - use destinations with negative availability (exceeded capacity); do not ignore resources with negative availability, and thus able to select for load balancing destinations with exceeded capacity. This might be needed in scenarios where we want to limit generic calls volume and always pass important/high-priority calls.
r - Relative value - the relative available load (how many percentages are free) is used in computing the load of each pear/resource; Without this flag, the Absolute value is assumed - the effective available load ( maximum_load - current_load) is used in computing the load of each pear/resource.
s - Pick a random destination if multiple destinations with the same load are found, instead of always picking first matched destination. This could help to offload an excessive load from the first destination and distribute load in situations when failed calls always routed to first destination, since they almost does not affect load counters of destinations.
attrs (var, optional) - a writable variable to be populated with the attributes of the selected destination.
The function may return:
1 (true) - if a new destination URI is set, pointing to the selected destination. NOTE that the RURI will not be changed by this function.
-1 (false) - generic internal error (memory allocation, parsing)
-2 (false) - no capacity available (detinations are up and available, but they do not have any availabe channels)
-3 (false) - no destinations available (the requested resources did not match any active destination)
-4 (false) - bad resources (requested resources do not exist)
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and FAILURE_ROUTE.
Example 1.13. lb_start usage
...
if (lb_start(1,"trascoding;conference")) {
# dst URI points to the new destination
xlog("sending call to $du\n");
t_relay();
exit;
}
...
Function to be used to pull the next available (and less loaded) destination. You need to have an ongoing LB session (started with lb_start()).
This function is mainly used for implementing failover for the LB destinations.
Meaning of the parameters is as follows:
attrs (var, optional) - a writable variable to be populated with the attributes of the selected destination.
The function may return:
1 (true) - if a new destination URI is set, pointing to the selected destination. NOTE that the RURI will not be changed by this function.
-1 (false) - generic internal error (memory allocation, parsing)
-2 (false) - no capacity available (detinations are up and available, but they do not have any availabe channels)
-3 (false) - no more destinations available (the requested resources did not match any active destination)
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
Example 1.14. lb_next() usage
...
if (t_check_status("(408)|(5[0-9][0-9])")) {
/* check next available LB destination */
if ( lb_next() ) {
t_on_failure("1");
xlog("-----------new dst is $du\n");
t_relay();
exit;
}
}
...
This is just a wrapper function to simplify scripting. If there is no ongoing LB session, it acts as lb_start(); If there is an ongoing LB session, it acts as lb_next().
Old name of the lb_start_or_next() function.
Take care, this will become obsolete.
Function to stop and flush a current LB session. To be used in failure route, if you want to stop the current LB session (not to try any other destinations from this session) and to start a completly new one.
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
Example 1.15. lb_next() usage
...
if (t_check_status("(5[0-9][0-9])")) {
/* check next available LB destination */
if ( lb_next() ) {
t_on_failure("1");
xlog("-----------new dst is $du\n");
t_relay();
exit;
}
} else if (t_check_status("(408)")) {
lb_reset();
if (lb_start(1,"conference")) {
t_relay();
exit;
}
}
...
Function to check if there is any ongoing LB session. Returns true if so.
This function can be used in any type of route.
Marks as disabled the last destination that was used for the current call. The disabling done via this function will prevent the destination to be used for usage from now on. The probing mechanism can re-enable this peer (see the probing section in the beginning)
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
Example 1.16. lb_disable_dst() usage
...
if (t_check_status("(408)|(5[0-9][0-9])")) {
lb_disable_dst();
if ( lb_next() ) {
t_on_failure("1");
xlog("-----------new dst is $du\n");
t_relay();
} else {
t_reply(500,"Error");
}
}
...
Checks if the given IP and PORT belongs to a destination configured in the load-balancer's list. Returns true if found and active (see the "active" parameter).
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
Meaning of the parameters is as follows:
ip (string) - IP to be checked
port (int) - PORT to be checked. A value 0 means "any" - will match any port.
group (int, optional) - in what LB group the destination should be looked for; If not specified, the search will be in all groups.
active (int, optional)- if "1", the search will be performed only over "active" (not disabled) destinations. If missing, the search will consider any kind of destinations.
attrs (var, optional) - a writable variable to be populated with the attributes of the identified destination.
Example 1.17. lb_is_destination usage
...
if (lb_is_destination($si,$sp) ) {
# request from a LB destination
}
...
The function counts the current call as load for a given destination with some given resources. Note that this call is not going through the load-balancing logic (there are not routing decision taken for the call); it is simply counted by LB as ongoing call for a destination;
Meaning of the parameters is as follows:
ip (string) - IP to identify the destination the call has to be counted for.
port (int) - PORT to identify the destination the call has to be counted for.
grp (int) - group id for the destinations; if no knows, "-1" will mean all groups.
resources - (string) a semi-colon separated list of resources required by the current call.
undo - (int, optional) if set to a non zero value, it will force the function to un-count - actually it will undo the counting of this call as load in the current LB session; this might be needed if we count call for particular resources and then need to un-count it.
Function returns true if the call was properly taken into consideration for estimating the load on the destination.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and FAILURE_ROUTE.
Example 1.18. lb_count_call usage
...
# count as load also the calls orgininated by lb destinations
if (lb_is_destination($si,$sp) ) {
# inbound call from destination
lb_count_call($si,$sp,-1,"conference");
} else {
# outbound call to destinations
if ( !load_balance(1,"conference") ) {
send_reply(503,"unavailable");
exit();
}
# dst URI points to the new destination
xlog("sending call to $du\n");
t_relay();
exit;
}
...
Trigers the reload of the load balancing data from the DB.
MI FIFO Command Format:
opensips-cli -x mi lb_reload
Changes the capacity for a resource of a destination.
Parameters:
destination_id - the ID (as per DB) of the destination.
res_name - name of the resource you want to resize.
new_capacity - new resource capacity.
MI FIFO Command Format:
opensips-cli -x mi lb_resize 11 voicemail 56
Lists all the destinations and the maximum and current load for each resource of the destination.
Example 1.19. lb_list usage
$ opensips-cli -x mi lb_list
Destination:: sip:127.0.0.1:5100 id=1 enabled=yes auto-re=on
Resource:: pstn max=3 load=0
Resource:: transc max=5 load=1
Resource:: vm max=5 load=2
Destination:: sip:127.0.0.1:5200 id=2 enabled=no auto-re=on
Resource:: pstn max=6 load=0
Resource:: trans max=57 load=0
Resource:: vm max=5 load=0
Gets or sets the status (enabled or disabled) of a destination.
Parameters:
destination_id - the ID (as per DB) of the destination.
new_status (optional) - If no new status is given, the function will return the current status. If a new status is given (0 - disable, 1 - enable), this status will be forced for the destination.
Example 1.20. lb_status usage
$ opensips-cli -x mi lb_status 2 enable:: no $ opensips-cli -x mi lb_status 2 1 $ opensips-cli -x mi lb_status 2 enable:: yes
This event is raised when the module changes the state of a destination, either through MI or probing.
Parameters:
group - the group of the destination.
uri - the URI of the destination.
status - disabled if the destination was disabled or enabled if the destination is being used.
3.1. | Where can I find more about OpenSIPS? |
Take a look at https://opensips.org/. | |
3.2. | Where can I post a question about this module? |
First at all check if your question was already answered on one of our mailing lists:
E-mails regarding any stable OpenSIPS release should be sent to
If you want to keep the mail private, send it to
| |
3.3. | How can I report a bug? |
Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues. |
Table 4.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 120 | 72 | 4276 | 746 |
| 2. | Liviu Chircu (@liviuchircu) | 42 | 33 | 683 | 172 |
| 3. | Vlad Patrascu (@rvlad-patrascu) | 37 | 18 | 621 | 761 |
| 4. | Sergey Khripchenko (@shripchenko) | 28 | 10 | 1058 | 516 |
| 5. | Razvan Crainea (@razvancrainea) | 25 | 19 | 260 | 142 |
| 6. | Vlad Paiu (@vladpaiu) | 5 | 3 | 7 | 5 |
| 7. | Walter Doekes (@wdoekes) | 5 | 3 | 3 | 3 |
| 8. | Jeremy Martinez (@JeremyMartinez51) | 5 | 2 | 193 | 1 |
| 9. | Ezequiel Lovelle (@lovelle) | 4 | 2 | 3 | 3 |
| 10. | Anca Vamanu | 3 | 1 | 20 | 9 |
All remaining contributors: Andrei Dragus, James Van Vleet, Dusan Klinec (@ph4r05), Peter Lemenkov (@lemenkov), Zero King (@l2dy).
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".
(3) ignoring whitespace edits, renamed files and auto-generated files
Table 4.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Liviu Chircu (@liviuchircu) | Sep 2012 - May 2024 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | Feb 2009 - Oct 2023 |
| 3. | Vlad Patrascu (@rvlad-patrascu) | Mar 2017 - Jul 2022 |
| 4. | Zero King (@l2dy) | Mar 2020 - Mar 2020 |
| 5. | Razvan Crainea (@razvancrainea) | Oct 2010 - Sep 2019 |
| 6. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 7. | Jeremy Martinez (@JeremyMartinez51) | Feb 2017 - Feb 2017 |
| 8. | Dusan Klinec (@ph4r05) | Dec 2015 - Dec 2015 |
| 9. | Sergey Khripchenko (@shripchenko) | Oct 2014 - Oct 2015 |
| 10. | Ezequiel Lovelle (@lovelle) | Oct 2014 - Oct 2014 |
All remaining contributors: Walter Doekes (@wdoekes), Vlad Paiu (@vladpaiu), Andrei Dragus, James Van Vleet, Anca Vamanu.
(1) including any documentation-related commits, excluding merge commits
Last edited by: Zero King (@l2dy), Vlad Patrascu (@rvlad-patrascu), Liviu Chircu (@liviuchircu), Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Peter Lemenkov (@lemenkov), Sergey Khripchenko (@shripchenko), Ezequiel Lovelle (@lovelle), Walter Doekes (@wdoekes), Vlad Paiu (@vladpaiu).
Documentation Copyrights:
Copyright © 2009 Voice Sistem SRL