Table of Contents
my_node_iddb_modedb_urldb_tablesharing_tagmy_node_infoneighbor_node_infoping_intervalping_timeoutnode_timeoutseed_fallback_intervalsync_timeoutsync_packet_sizedispatch_jobsid_colcluster_id_colnode_id_colurl_colstate_colno_ping_retries_colpriority_colsip_addr_colflags_coldescription_colenable_stats (integer)enable_rerouting (integer)clusterer_reload
clusterer_list
clusterer_list_topology
clusterer_set_status
clusterer_remove_node
cluster_send_mi
cluster_broadcast_mi
clusterer_list_cap
clusterer_set_cap_status
clusterer_shtag_set_activeclusterer_list_shtagsget_nodes(cluster_id)
free_nodes(list)
set_state(cluster_id, state)
check_addr(cluster_id, su)
get_my_id()
send_to(packet, cluster_id, node_id)
send_all(packet, cluster_id)
get_next_hop(cluster_id, node_id)
free_next_hop(next_hop)
register_module(mod_name, cb, auth_check, accept_clusters_ids, no_accept_clusters)
List of Tables
List of Examples
my_node_id parameterdb_mode parameterdb_url parameterdb_table parametersharing_tag parametermy_node_info parameterneighbor_node_info parameterping_interval parameterping_timeout parameternode_timeout parameterseed_fallback_interval parametersync_timeout parametersync_packet_size parameterdispatch_jobs parameterid_col parametercluster_id_col parameternode_id_col parameterurl_col parameterstate_col parameterno_ping_retries_col parameterpriority_col parametersip_addr_col parameterflags_col parameterdescription_col parameterenable_stats parameterenable_rerouting parameterclusterer_list usageclusterer_list_topology usageclusterer_list_cap usageThe clusterer module is used to organize multiple OpenSIPS instances into groups(clusters) in which the nodes can communicate with each other in order to replicate, share information or perform distributed tasks. The distributed logic is performed either by different modules that use the clusterer interface (i.e. the dialog module can replicate dialogs/profiles, the ratelimit module can share pipes across multiple instances etc.) or at the script level. The clusterer module itself only provides an interface to send/receive BIN packets and get notifications about node availability. It achieves this by internally learning the cluster topology and state of the nodes. Provisioning the nodes within a cluster is done over the database or through the configuration script. The node-related information can be checked and triggered to be reloaded by sending commands over the MI interface.
The topology established by the clusterer module is an overlay of nodes where the "links" represent communication availability at BIN interface level. For this purpose, a probing mechanism is used, consisting of regular pings to all nodes in a cluster for which replies must be received within a given interval. All nodes in the cluster exchange information about the state of their links with other nodes and compute a "routing table" which gives a next hop for each destination. The metric for the shortest path is the number of hops. When there is no direct link to a destination, the BIN packet sent by a module is transparently routed through the cluster.
Note that an OpenSIPS instance can belong to multiple clusters, communicating and establishing the topology separately for each one. In order to provision this in the database or the script, each node has an unique ID at global level, which can be referenced in each cluster.
An OpenSIPS instance can dynamically learn all the nodes in the cluster if database provisioning is not desired. It is enough to define at least one neigbour in the script in order to discover all the cluster components.
The clusterer module also keeps track of the state of the nodes in terms of data synchronization for the functionalities (or "capabilities") implemented on top by other modules. Some capabilities require a full data sync(at OpenSIPS startup or at runtime via MI) from a valid "donor" node in the cluster that has the full data set. Furthermore, a capability can query the clusterer module in order to partition some distributed logic only over the synchronized nodes in the cluster.
Each node in the cluster starts with an empty dataset and tries to find a suitable node to pull data from. In order to help "bootstrap" the cluster, a "seed" node should be defined. This is done by setting the value seed for the flags column in the clusterer table(or the property with the same name in the my_node_info parameter). The seed node will simply fall back to a "synced" state after a configurable interval( seed_fallback_interval parameter). Note that this mechanism is required only for capabilities that synchronize data at startup, so check the corresponding modules documentation.
The clusterer module transparently exposes the sip_addr column from the clusterer table(or the property with the same name in the my_node_info parameter) to the modules on top so check the corresponding modules documentation for the use of this node related information.
The following modules must be loaded before this module:
a database module - if db_mode is 1.
proto_bin module.
The id of the local instance. This parameter must be equal to one of the node_id fields in the database.
No default value. This parameter must be explicitly set to a value greater than zero.
Specifies whether the node information for the local instance, as well as other instances in the cluster, should be loaded from the database or configured in the script(see my_node_info and neighbor_node_info). A value of “0” means that DB is not used and the cluster topology in terms of node information will be discovered dynamically at runtime.
If DB mode is enabled, only the nodes defined in the database will be accepted by this instance.
Default value is “1”
The database url.
Default value is “NULL”.
Example 1.3. Set db_url parameter
...
modparam("clusterer", "db_url",
"mysql://opensips:opensipsrw@localhost/opensips")
...
The name of the table storing the clustering information.
Default value is “clusterer”.
The definition of a sharing tag. The sharing tag is managed by the clusterer module, but can be used (in terms of reading its state) by any module build on top of clusterer engine, like dialog or presence.
Note that other tags may be dynamically learned during runtime via clustering communication with other nodes.
The format for this value is “tag_name / cluster_id = active/backup”.
Multiple definitions of this parameter are allowed. The default value is “none”.
Example 1.5. Set sharing_tag parameter
...
modparam("clusterer", "sharing_tag", "vip1/2=active")
modparam("clusterer", "sharing_tag", "node/10=backup")
...
Node specification similar to the information provided by a row in the clusterer DB table corresponding to the local instance. This parameter can be set multiple times in order to include the local node in multiple clusters.
Parameter format: multiple "prop=value" property definitions separated by ',' where the name of the properties is the same as the DB column names. At least the cluster_id and url properties must be defined.
This parameter is required if db_mode is set to “0” in order to properly advertise information about the local instance in the dynamic node learning process.
Example 1.6. Set my_node_info parameter
...
modparam("clusterer", "my_node_info", "cluster_id=1, url=bin:192.168.0.5:5566")
...
Node specification similar to the information provided by a row in the clusterer DB table corresponding to another instance in the cluster. This node will be the entry point in the cluster for the local instance in the dynamic node learning process. This parameter can be set multiple times to define multiple neigbors to connect to (or the same neighbor but in different clusters).
Parameter format: multiple "prop=value" property definitions separated by ',' where the name of the properties is the same as the DB column names. At least the cluster_id, node_id and url properties must be defined.
This parameter should be set at least once if db_mode is set to 0 in order to properly learn the cluster topology. If not set, the only way to learn the node topology is by other nodes connecting to the local instance.
Example 1.7. Set neighbor_node_info parameter
...
modparam("clusterer", "neighbor_node_info", "cluster_id=1,node_id=2,url=bin:192.168.0.6:5566")
...
The interval in seconds between regular pings sent to a neighbour node.
Default value is “4”
The time in milliseconds to wait for a reply to a previously sent ping before retrying or considering the link with the neighbour node down. This is also the interval between successive retries if the send fails.
Default value is “1000”
The time in seconds to wait before pinging is restarted for a failed node.
Default value is “60”
Only relevant for "seed" nodes. The time, in seconds, to wait for a suitable donor node before falling back to a "synced" state, following a node restart or an MI cluster sync command.
Default value is “5”.
Example 1.11. Set seed_fallback_interval parameter
...
modparam("clusterer", "seed_fallback_interval", 10)
...
The inteval, in seconds, since the last sync data packet received after which to consider the sync process as failed and revert the node to the not synced state.
Default value is “15”.
The maximum size of the BIN packets sent while doing data synchronization. This is only a suggested value as the actual size of the packets may be slightly larger.
Default value is “65535”.
Example 1.13. Set sync_packet_size parameter
...
modparam("clusterer", "sync_packet_size", 32765)
...
Enables the dispatching of jobs(processing replicated data packets) from the receiving TCP worker process to free opensips workers (including UDP, timer processes etc.).
This generally improves the performance of handling replication packets in high traffic scenarios and should not be disabled.
Nevertheless there are cases where the "thundering herd" problem occurs which causes abnormaly high CPU loads. Disabling this dispatching mechanism solves such issues.
Default value is “1” (enabled).
The name of the column storing an id for the table rows.
Default value is “id”.
The name of the column to store the id of a cluster.
Default value is “cluster_id”.
Example 1.16. Set cluster_id_col parameter
...
modparam("clusterer", "cluster_id_col", "cluster_id")
...
The name of the column to store the id of an instance. The values must be greater than 0.
Default value is “node_id”.
The name of the column containing the instance url. The values must be greater than 0.
Default value is “url”.
The name of the column storing the state of the node(enabled/disabled).
Default value is “state”.
The name of the column containing the maximum number of ping retries before the link with the neighbour node is considered down.
Default value is “no_ping_retries”.
Example 1.20. Set no_ping_retries_col parameter
...
modparam("clusterer", "no_ping_retries_col", "no_ping_retries")
...
The name of the column storing the node priority to be chosen as next hop in case of same length(number of hops) paths when rerouting messages.
Default value is “priority”.
The name of the column containing a SIP address for the node.
Default value is “sip_addr”.
The name of the column containing the node flags.
Default value is “flags”.
The name of the column containing a node description.
Default value is “description”.
Example 1.24. Set description_col parameter
...
modparam("clusterer", "description_col", "description")
...
If the statistics support should be enabled or not. Via statistic variables, the module provide information about the cluster nodes. Set it to zero to disable or to non-zero to enable it.
Default value is “1 (enabled)”.
If packets should be rerouted via another node if a direct route to destination is unavailible. Disabling may improve stability in two-node topologies. Set it to zero to disable or to non-zero to enable it.
Default value is “1 (enabled)”.
This function is used to send a generic, request-like message, containing custom data, to a specific node in a cluster, directly from the script. The message is not a "request" per se but according to the logic on the receiving side, that node can send back a reply. In order to correlate a received reply with the request sent out, the function returns, through the tag parameter, a randomly generated communication tag, which is sent along in the the original message, that can be checked against the tag received in a reply.
Meaning of the parameters is as follows:
cluster_id (int) - the cluster ID of the destination node;
dst_id (int) - the ID of the destiantion node;
msg (string) - actual message payload;
tag (var, optional) - randomly generated communication tag.
The function can return the following values:
1 - successfully sent message to destination node or a valid next hop
-1 - local node is disabled so sending is impossbile
-2 - destination node is not reachable through any path according to the discovered topology
-3 - destination node or valid next hop appear to be reachable but send failed or other OpenSIPS internal error
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.
Example 1.27. cluster_send_req() usage
...
# send a request
cluster_send_req(1, 1, "Check USER: $fU", $var(req_tag));
# wait for reply
$avp(filter) = "tag=" + $var(req_tag);
async(wait_for_event("E_CLUSTERER_RPL_RECEIVED", $avp(filter), 5), rpl_resume);
# done
...
route[rpl_resume] {
xlog("Received reply: $avp(msg)\n");
}
...
This function is used to send a generic, reply-like message, containing custom data, to a specific node in a cluster, directly from the script. The message is marked as a "reply" so this function should ony be used for replying to a previously request-like message received. In order for the other node, which initially sent a request, to be able to correlate it with this reply, a communication tag, received along with the request, should be passed to the function.
Meaning of the parameters is as follows:
cluster_id (int) - the cluster ID of the destination node;
dst_id (int) - the ID of the destiantion node;
msg (string) - actual message payload;
tag (var) - communication tag.
The function can return the following values:
1 - successfully sent message to destination node or a valid next hop
-1 - local node is disabled so sending is impossbile
-2 - destination node is not reachable through any path according to the discovered topology
-3 - destination node or valid next hop appear to be reachable but send failed or other OpenSIPS internal error
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.
Example 1.28. cluster_send_rpl() usage
...
event_route[E_CLUSTERER_REQ_RECEIVED] {
cluster_send_rpl($param(cluster_id), $param(src_id), $var(my_reply), $param(tag));
}
...
This function has a similar behaviour to the cluster_send_req() function with the exception that the message is sent to all the nodes in the specified cluster.
The function can return the following values:
1 - successfully sent message to at least one node;
-1 - local node is disabled so sending is impossbile;
-2 - all nodes in the cluster are unreachable according to the discovered topology;
-3 - send failed for all nodes in the cluster or other OpenSIPS internal error.
The meaning of the parameters is the same as for cluster_send_req().
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.
Example 1.29. cluster_broadcast_req() usage
... cluster_broadcast_req($var(cl_id), $var(share_data)); ...
This function checks whether the given IP address belongs to one of the nodes in the cluster.
Parameters:
cluster_id (int)
ip (string)
addr_type (string, optional) - select the address of the node that the comparison is made against, with the possible values of:
"sip" (default) - a node's DB provisioned SIP address
"bin" - a node's BIN interface listener
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.
Reloads data from the clusterer database. The currently established topology will be lost and the node will rediscover the new topology.
Name: clusterer_reload
Parameters:none
MI FIFO Command Format:
opensips-cli -x mi clusterer_reload
Lists information(node id, URL, link state with that node etc.) about the other nodes in each cluster.
Name: clusterer_list
Parameters:none
Example 1.31. clusterer_list usage
$ opensips-cli -x mi clusterer_list
{
"Clusters": [
{
"cluster_id": 1,
"Nodes": [
{
"node_id": 1,
"db_id": 1,
"url": "bin:127.0.0.1",
"link_state": "Up",
"next_hop": "1",
"description": "none"
}
]
}
]
}
Lists each cluster's topology from the local node's perspective as an adjacency list. A node appears as a neighbour if the link with that node is up.
Note that if a node id appears in multiple clusters, it refers to the same instance that belongs to different clusters, for which it has a different topology.
Name: clusterer_list_topology
Parameters:none
Example 1.32. clusterer_list_topology usage
$ opensips-cli -x mi clusterer_list_topology
{
"Clusters": [
{
"cluster_id": 1,
"Nodes": [
{
"node_id": 2,
"Neighbours": [
1
]
},
{
"node_id": 1,
"Neighbours": [
2
]
}
]
}
]
}
Sets the status(Enabled/Disabled) of a node. If the local instance is disabled, the node will not send any messages and ignore received ones thus appearing as a failed node in the topology (from the other node's perspective). If a different node is disabled, the specified node will simply be ignored by the local instance in terms of sending/receiving any messages, as if no longer part of the topology.
Name: clusterer_set_status
Parameters:
cluster_id - indicates the id of the cluster.
node_id (optional) - indicates the id of the node to be disabled. If missing, the local instance will be disalbed.
status - indicates the new status(0 - Disabled, 1 - Enabled).
MI FIFO Command Format:
#disable the local instance opensips-cli -x mi clusterer_set_status 1 0 #disable node ID 3 opensips-cli -x mi clusterer_set_status 1 3 0
Removes a node from the cluster's topology. It is enough to run the function on a single node in order to remove the target node from all the other nodes in the cluster. If the node to be removed is running when triggering this function, it will be automatically disabled (equivalent to running clusterer_set_status on that specific node).
This function can only be used when db_mode is set to 0 (disabled).
Name: clusterer_remove_node
Parameters:
cluster_id - cluster ID
node_id - ID of the node to be removed.
MI FIFO Command Format:
opensips-cli -x mi clusterer_remove_node 1 3
Dispatches a given MI command to be run on a specific node in the cluster.
Name: cluster_send_mi
Parameters:
cluster_id - id of the cluster.
destination - id of the destination node
cmd_name - name of the MI command to be run
cmd_params (optional) - array of parameters for the MI command to be run
Note that MI commands that require named parameters or arrays as parameter values are not currently supported.
MI FIFO Command Format:
opensips-cli -x mi cluster_send_mi 1 3 lb_reload
Dispatches a given MI command to be run on all the nodes in a cluster. The command is also executed locally.
Name: cluster_broadcast_mi
Parameters:
cluster_id - id of the cluster.
cmd_name - name of the MI command to be run
cmd_params (optional) - array of parameters for the MI command to be run
Note that MI commands that require named parameters or arrays as parameter values are not currently supported.
MI FIFO Command Format:
opensips-cli -x mi cluster_broadcast_mi 1 dr_reload partition_5
Lists the registered capabilities and their states.
Name: clusterer_list_cap
Parameters:none
Example 1.33. clusterer_list_cap usage
$ opensips-cli -x mi clusterer_list_cap
{
"Clusters": [
{
"cluster_id": 1,
"Capabilities": [
{
"name": "dialog-dlg-repl",
"state": "Ok",
"enabled": "yes"
},
{
"name": "dialog-prof-repl",
"state": "Ok",
"enabled": "yes"
}
]
}
]
}
Sets the status(Enabled/Disabled) of a capability. If a capability is disabled, the node will not send any replication/sync messages belonging to that capability. Likewise, received messages will be dropped. Also, the cabability will transition to a "not synced" state and the node will no longer be able to be a donor for syncing.
Name: clusterer_set_cap_status
Parameters:
cluster_id - the id of the cluster
capability - name of the capability, as listed by clusterer_list_cap
status - indicates the new status(0 - Disabled, 1 - Enabled).
MI FIFO Command Format:
#disable dialog replication in cluster 1 opensips-cli -x mi clusterer_set_cap_status 1 dialog-dlg-repl 0 #enable dialog profile replication in cluster 2 opensips-cli -x mi clusterer_set_cap_status 2 dialog-prof-repl 1
Set the given sharing tag to the active state. The information about this change is also broadcasted in the cluster in order to force any other node that may be active on this tag to step down to backup.
Name: clusterer_shtag_set_active
Parameters: tag - the name of the tag to be set active and the cluster it belogs to, in the format 'tag/cluster_id'.
MI FIFO Command Format:
opensips-cli -x mi clusterer_shtag_set_active vip1/3
This is a read/write variable that allows access to the sharing tags managed by the clusterer module.
The name of such a variable has the format of tag_name/cluster_id, like $cluster.sh_tag(vip/3) accessing the sharing tag "vip" from cluster ID 3.
When setting, a sharing tag may be only switched to active by assigned it:
When reading it value, a sharing tag returns:
A NULL value may returned only as a result of an internal error (like memory errors).
This event is raised when a generic, request-like, clusterer message is received. This type of message is sent directly from the script and not by an OpenSIPS module.
Parameters:
cluster_id - The cluster ID of the source node.
src_id - The ID of the source node.
msg - The actual message payload.
tag - The communication tag of this message, generated by the source node. This could be used to send a reply corresponding to the received message by providing the tag to the cluster_send_rpl() function.
This event is raised when a generic, reply-like, clusterer message is received. This type of message is sent directly from the script and not by an OpenSIPS module.
Parameters:
cluster_id - The cluster ID of the source node.
src_id - The ID of the source node.
msg - The actual message payload.
tag - The communication tag of this message. This could be used to match the received reply with a request sent with the cluster_send_req() or cluster_broadcast_req() functions.
This event is raised when the state of a node changes in terms of availability.
Parameters:
cluster_id - The cluster ID.
node_id - The ID of the node.
new_state - The new state of the node, with the possible values: 0 - down, 1 - up.
This event is raised when the state of a sharing tag changes.
Parameters:
name - The name of the sharing tag.
cluster_id - The cluster ID.
node_id - The ID of the node.
state - The new state of the sharing tag, the possible values: "active" or "backup".
reason - short text describing what triggered the change of the state, like a another node stepping as active, an MI command or script variable.
The module provides the clusterer Status/Report group.
The sharing_tags identifier is provided for reporting state changes of the sharing_tags (between active and backup), along with the reason of the change. This identifier has a 200 records history before discarding the old ones.
{
"Name": "sharing_tags",
"Reports": [
{
"Timestamp": 1652367224,
"Date": "Thu May 12 17:53:44 2022",
"Log": "TAG <HA>, cluster 1, became backup due to cluster broadcast from 2"
},
{
"Timestamp": 1652367326,
"Date": "Thu May 12 17:55:26 2022",
"Log": "TAG <HA>, cluster 1, became active due to MI command"
}
]
}
The node_states identifier is used for reporting node state changes (in terms of availability). This identifier has a 200 records history before discarding the old ones.
{
"Name": "node_states",
"Reports": [
{
"Timestamp": 1656489246,
"Date": "Wed Jun 29 10:54:06 2022",
"Log": "Node [2], cluster [1] is UP"
},
{
"Timestamp": 1656489261,
"Date": "Wed Jun 29 10:54:21 2022",
"Log": "Node [2], cluster [1] is DOWN"
}
]
}
Each capability registered to the clusterer module has a corresponding identifier, named cap:[capability_name], used for providing the status of the data syncing for that capability. This status reflects the progress of the syncing process and can have the following values:
-3 - not synced
-2 - sync pending (waiting for either a suitable donor node or actual sync data)
-1 - sync in progress
1 - synced (either sync has completed or the capability does not require data syncing at all)
{
"Name": "cap:dialog-dlg-repl",
"Readiness": true,
"Status": 1,
"Details": "synced"
},
The capability identifiers also provide reports regarding the main stages of the sync process. These identifiers have a 200 records history before discarding the old ones.
{
"Name": "cap:dialog-dlg-repl",
"Reports": [
{
"Timestamp": 1656966903,
"Date": "Mon Jul 4 23:35:03 2022",
"Log": "Sync requested"
},
{
"Timestamp": 1656966904,
"Date": "Mon Jul 4 23:35:04 2022",
"Log": "Sync started from node [1]"
},
{
"Timestamp": 1656966906,
"Date": "Mon Jul 4 23:35:06 2022",
"Log": "Sync completed, received [10000] chunks"
}
]
},
For how to access and use the Status/Report information, please see Status/Report Interface documentation.
This section provides an usage example for replicating ratelimit pipes between two OpenSIPS instances. It uses the clusterer module to manage the replicating nodes, and along with the proto_bin module, to send the replicated information.
The setup topology is simple: we have two OpenSIPS nodes running on two separate machines (although they could run on the same machine as well): Node A has IP 192.168.0.5 and Node B has IP 192.168.0.6. Both have, besides the traffic listeners (UDP, TCP, etc.), BIN listeners bound on port 5566. These listeners will be used for the binary communication.
We insert in the the clusterer table the following:
Example 1.34. Example database content - clusterer table
+----+------------+---------+----------------------+-------+-----------------+----------+----------+-------+-------------+ | id | cluster_id | node_id | url | state | no_ping_retries | priority | sip_addr | flags | description | +----+------------+---------+----------------------+-------+-----------------+----------+----------+-------+-------------+ | 10 | 1 | 1 | bin:192.168.0.5:5566 | 1 | 3| 50 | NULL | NULL | Node A | | 20 | 1 | 2 | bin:192.168.0.6:5566 | 1 | 3| 50 | NULL | NULL | Node B | +----+------------+---------+----------------------+-------+-----------------+----------+----------+-------+-------------+
“cluster_id” - identifier of the cluster. All nodes within a group/cluster should have the same id (in our example, both nodes have ID 1). The values must be greater than 0.
“node_id” - identifier of the machine/node so each instance within a cluster should have a different ID. The values must be greater than 0. In our example, Node A will have ID 1, and Node B ID 2.
“url” - address where all the BIN packets for that instance will be sent to.
“state” - state of the node: 1 means Enabled, 0 means Disabled. A disabled node will not send any BIN packets and will drop received ones.
“no_ping_retries” - maximum number of ping retries before the link with a node is considered down.
“priority” - the priority of a node to be chosen as next hop in case of same length(number of hops) paths when rerouting messages; it is not relevant for this two-node topology example.
“sip_addr” - SIP address for the node that is transparently provided to modules; it has no use for the ratelimit module in our example.
“flags” - used to define a seed node; it has no use in our example.
“description” - an opaque value used to describe the node
After provisioning the two nodes in the database, we have to configure the two instances of OpenSIPS. First, we configure Node A:
Example 1.35. Node A configuration
...
socket= bin:192.168.0.5:5566 # bin listener for Node A
loadmodule "proto_bin.so"
loadmodule "clusterer.so"
modparam("clusterer", "db_url", "mysql://opensips@192.168.0.7/opensips")
modparam("clusterer", "my_node_id", 1) # node_id for Node A
loadmodule "ratelimit.so"
modparam("ratelimit", "pipe_replication_cluster", 1)
...
Similarly, the configuration for Node B is as follows:
Example 1.36. Node B configuration
...
socket= bin:192.168.0.6:5566 # bin listener for Node B
loadmodule "proto_bin.so"
loadmodule "clusterer.so"
# ideally, use the same database for both nodes
modparam("clusterer", "db_url", "mysql://opensips@192.168.0.7/opensips")
modparam("clusterer", "my_node_id", 2) # node_id for Node B
loadmodule "ratelimit.so"
modparam("ratelimit", "pipe_replication_cluster", 1)
...
Starting the two OpenSIPS instances with the above configurations provides your platform the ability to used shared ratelimit pipes in a very efficient and scalable way.
This function will return a list of all the reachable nodes(if the direct link is down/probing, a path through intermediary nodes is considered) in the specified cluster.
The returned nodes structure:
...
typedef struct clusterer_node {
int node_id;
union sockaddr_union addr;
str sip_addr;
str description;
struct clusterer_node *next;
} clusterer_node_t;
...
Meaning of the parameters is as follows:
int cluster_id - the cluster id
This function will free the lits of nodes returned by get_nodes.
Meaning of the parameters is as follows:
clusterer_node_t *list - list header
This function sets the state(enabled/disabled) of the current node in the specified cluster.
Meaning of the parameters is as follows:
int cluster_id - the cluster id
enum cl_node_state state - the new state; possible values:
STATE_DISABLED
STATE_ENABLED
This function checks if a given address belongs to one of the nodes in the cluster.
Meaning of the parameters is as follows:
int cluster_id - the cluster id
union sockaddr_union* su - socket address
This functon will send the given BIN packet to the specified node in the cluster. If the direct link is down/probing, it will send the packet to an intermediary node if the destination node is reachable through another path in the cluster topology.
Meaning of the parameters is as follows:
bin_packet_t packet - the packet to be sent
int cluster_id - the cluster id
int node_id - the id of the destination node
The function returns one of the following:
CLUSTERER_SEND_SUCCESS - successfully sent packet to destination node or a valid next hop
CLUSTERER_CURR_DISABLED - current node is disabled so sending is impossbile
CLUSTERER_DEST_DOWN - destination node is not reachable through any path according to the discovered topology
CLUSTERER_SEND_ERR - destination node or valid next hop appear to be reachable but send failed
Send the given BIN packet to all the nodes in the specified cluster. The function operates similarly to send_to.
Meaning of the parameters is as follows:
bin_packet_t packet - the packet to be sent
int cluster_id - the cluster id
The function returns one of the following:
CLUSTERER_SEND_SUCCESS - successfully sent packet to at least one node
CLUSTERER_CURR_DISABLED - current node is disabled so sending is impossbile
CLUSTERER_DEST_DOWN - all nodes in the cluster are unreachable according to the discovered topology
CLUSTERER_SEND_ERR - send failed for all nodes in the cluster
This function returns the next hop from the computed shortest path to the given destination node in the specified cluster. This is the node that is the actual destination for the send_to and send_all functions when the direct link with the intended destination is down. The function returns the same structure as get_nodes.
Meaning of the parameters is as follows:
int cluster_id - the cluster id
int node_id - the node id of the destination for which the next hop is returned.
This function will free the next hop returned by get_next_hop.
Meaning of the parameters is as follows:
clusterer_node_t *next_hop - next hop to be freed
This function registers an OpenSIPS module in order to receive BIN packets and cluster notifications. A certain module can accept packets from multiple clusters and provides a single callback function that will be called for each received packet. This function will also be called to notify cluster events like nodes becoming reachable/unreachable.
Meaning of the parameters is as follows:
char *mod_name - module name
clusterer_cb_f cb - callback function
int auth_check - 0 - no check, 1 - for every BIN packet received check if source IP belongs to one of the nodes in the cluster
int* accept_clusters_ids - array of cluster ids from which packets are accepted
int no_accept_clusters - length of accept_clusters_ids array
The callback function prototype:
...
typedef void (*clusterer_cb_f)(enum clusterer_event ev,bin_packet_t *, int packet_type,
struct receive_info *ri, int cluster_id, int src_id, int dest_id);
...
Possble values for the event signaled through ev parameter of the callback funtion:
CLUSTER_RECV_MSG - received BIN message
CLUSTER_ROUTE_FAILED - failed to route a received BIN packet destined for another node in the cluster
CLUSTER_NODE_UP - a node became reachable
CLUSTER_NODE_DOWN - a node became unreachable
Table 3.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Vlad Patrascu (@rvlad-patrascu) | 364 | 135 | 13387 | 7101 |
| 2. | Liviu Chircu (@liviuchircu) | 68 | 52 | 801 | 522 |
| 3. | Eseanu Marius Cristian (@eseanucristian) | 46 | 10 | 3142 | 534 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | 31 | 16 | 1342 | 128 |
| 5. | Razvan Crainea (@razvancrainea) | 27 | 21 | 327 | 148 |
| 6. | Ionel Cerghit (@ionel-cerghit) | 9 | 2 | 250 | 212 |
| 7. | Maksym Sobolyev (@sobomax) | 8 | 6 | 12 | 13 |
| 8. | Alexandra Titoc | 6 | 4 | 18 | 4 |
| 9. | Jasper Hafkenscheid | 4 | 2 | 107 | 2 |
| 10. | Fabian Gast (@fgast) | 4 | 2 | 3 | 3 |
All remaining contributors: Gohar Ahmed (@goharahmed), kworm83, Peter Lemenkov (@lemenkov), Shanee Vanstone.
(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 3.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Liviu Chircu (@liviuchircu) | Mar 2016 - Dec 2024 |
| 2. | Razvan Crainea (@razvancrainea) | Nov 2015 - Sep 2024 |
| 3. | Alexandra Titoc | Sep 2024 - Sep 2024 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Apr 2016 - Sep 2024 |
| 5. | Shanee Vanstone | Mar 2024 - Mar 2024 |
| 6. | Maksym Sobolyev (@sobomax) | Jan 2021 - Nov 2023 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | Jul 2016 - Jul 2023 |
| 8. | Jasper Hafkenscheid | May 2022 - Jul 2022 |
| 9. | kworm83 | Feb 2021 - Feb 2021 |
| 10. | Fabian Gast (@fgast) | Nov 2018 - Jul 2020 |
All remaining contributors: Gohar Ahmed (@goharahmed), Peter Lemenkov (@lemenkov), Ionel Cerghit (@ionel-cerghit), Eseanu Marius Cristian (@eseanucristian).
(1) including any documentation-related commits, excluding merge commits
Last edited by: Liviu Chircu (@liviuchircu), Shanee Vanstone, Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Jasper Hafkenscheid, Fabian Gast (@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Eseanu Marius Cristian (@eseanucristian).
Documentation Copyrights:
Copyright © 2015-2017 www.opensips-solutions.com