Adding Load Sharing to Routing Script - Revision history

Allyntree at 17:37, 1 September 2020

2020-09-01T17:37:10Z

Abrassard: Updating doc to point to correct script

2018-12-20T13:26:04Z

Updating doc to point to correct script

Luc Morissette at 14:54, 27 June 2018

2018-06-27T14:54:27Z

Luc Morissette: Added note on Load sharing script

2018-06-27T14:54:05Z

Added note on Load sharing script

Lucas Trottier: /* Adding New Custom Variables */

2015-04-23T09:36:53Z

Adding New Custom Variables

Lucas Trottier: /* Setting up Filter Scripts */

2015-04-23T09:36:42Z

Setting up Filter Scripts

Luc Morissette: New page

2014-01-30T18:58:37Z

New page

New page

This shows how to add Priority and Load sharing to any Routing scripts. This is a powerful script that allows to regroup Routes of the same kind, distribute load among them and prioritize one group versus another. Alternatively, you can do the same on NAPs. You will use two additional parameters in the routes: '''group''' and '''weight'''. 
'''group''' serves as two purpose:
# priority: a lower value will have higher priority
# matching routes of the same group will load share according to the weight parameter
'''weight''' will load share calls among matching routes of the same group
 

== Setting up Filter Scripts ==

To setup a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, or any other script. 

First, go to the routing script section of the Web portal
<pre>Gateway -> Routing scripts -> Example Scripts -> simple_routing.rb [Edit]
</pre>
Three things need to be added. At the start of the script: 
<pre>require 'nap_group_weight_load_balancer'
</pre>
In the main class: 
<pre>include NapGroupAndWeightLoadBalancer
</pre>
<pre>after_filter :method => :filter_by_group_and_weight
</pre>
 
The final script will look like this:
<pre>
require 'base_routing'
require 'nap_group_weight_load_balancer'

class NapGroupAndWeightRouting < BaseRouting
include NapGroupAndWeightLoadBalancer

route_match :call_field_name => :called
route_match :call_field_name => :calling
route_match :call_field_name => :nap
route_match :method => :match_nap_availability
route_remap :call_field_name => :called, :route_field_name => :remapped_called
route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
route_remap :call_field_name => :nap, :route_field_name => :remapped_nap

after_filter :method => :filter_by_group_and_weight

end
</pre>
== Adding New Custom Variables ==
You need to add two custom columns to use this script. There is a default value creates and it can be changed in each route afterwards.
<pre>Gateway -> Routes -> Create New Route Column</pre>
'''Name''': group '''Type attributes''': integer '''Default''': 10 

<pre>Gateway -> Routes -> Create New Route Column</pre>
'''Name''': Weight '''Type attributes''': integer '''Default''': 100

← Older revision		Revision as of 17:37, 1 September 2020
Line 1:		Line 1:
−	This ~~shows~~ how to integrate a routing script filter that sorts matching routes by priority and weight (weight being used for load-sharing when multiple routes have the same priority).	+	This article show you how to integrate a routing script filter that sorts matching routes by priority and weight (weight being used for load-sharing when multiple routes have the same priority).

	Once ordered, the routes will be used one after the other until a route is working (according to [[Route_retry\|Route Retry]] parameters).		Once ordered, the routes will be used one after the other until a route is working (according to [[Route_retry\|Route Retry]] parameters).

@@ Line 1: / Line 1: @@
-This shows how to add Priority and Load sharing to any Routing scripts. This is a powerful script that allows to regroup Routes of the same kind, distribute load among them and prioritize one group versus another.  Alternatively, you can do the same on NAPs.  You will use two additional parameters in the routes: '''group''' and '''weight'''.<br />
+This shows how to integrate a routing script filter that sorts matching routes by priority and weight (weight being used for load-sharing when multiple routes have the same priority).
-'''group''' serves as two purpose:
-# priority: a lower value will have higher priority
+Once ordered, the routes will be used one after the other until a route is working (according to [[Route_retry|Route Retry]] parameters).
-# matching routes of the same group will load share according to the weight parameter
-'''weight''' will load share calls among matching routes of the same group
-<br>
 '''NOTE: starting from version 3.0.80 this script is installed by default''' (only for new installations, or a fresh routing script)
@@ Line 16: / Line 13: @@
 </pre>
 Three things need to be added. At the start of the script:<br>
-<pre>require 'nap_group_weight_load_balancer'
+<pre>require 'priority_and_weight_load_balancer' unless defined?(PriorityAndWeightLoadBalancer)</pre>
 </pre>
 In the main class:<br>
-<pre>include NapGroupAndWeightLoadBalancer
+<pre>include PriorityAndWeightLoadBalancer
 </pre>
-<pre>after_filter&nbsp;:method =&gt;&nbsp;:filter_by_group_and_weight
+<pre>
 </pre>
 <br>
-The final script will look like this:
+The final script will look like this (with possibly other filters also included):
 <pre>
 require 'base_routing'
-require 'nap_group_weight_load_balancer'
+require 'priority_and_weight_load_balancer' unless defined?(PriorityAndWeightLoadBalancer)
 class SimpleRouting < BaseRouting
-   include NapGroupAndWeightLoadBalancer
+   include PriorityAndWeightLoadBalancer
    route_match :call_field_name => :called
@@ Line 40: / Line 40: @@
    route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
-   after_filter&nbsp;:method =&gt;&nbsp;:filter_by_group_and_weight
+   after_filter :method => :filter_by_priority_and_weight,
+               :weight_by                 => :call_attempts,
 end
 </pre>
@@ Line 48: / Line 50: @@
 You need to add two custom columns to use this script. There is a default value creates and it can be changed in each route afterwards.
 <pre>Gateway -&gt; Routes -&gt; Create New Route Column</pre>
-'''Name''': group<br>'''Type attributes''': integer<br>'''Default''': 10 <br>
+'''Name''': priority<br>'''Type attributes''': integer<br>'''Default''': 10 <br>
 <pre>Gateway -&gt; Routes -&gt; Create New Route Column</pre>
 '''Name''': weight<br>'''Type attributes''': integer<br>'''Default''': 100 <br>

@@ Line 6: / Line 6: @@
 <br>
-'''NOTE: starting from version 3.0.80 this script is installed by default (only for new installations, or a fresh routing script)'''
+'''NOTE: starting from version 3.0.80 this script is installed by default''' (only for new installations, or a fresh routing script)
 == Setting up Filter Scripts<br>  ==

@@ Line 5: / Line 5: @@
 '''weight''' will load share calls among matching routes of the same group
 <br>
 == Setting up Filter Scripts<br>  ==

← Older revision		Revision as of 09:36, 23 April 2015
Line 49:		Line 49:

	<pre>Gateway -> Routes -> Create New Route Column</pre>		<pre>Gateway -> Routes -> Create New Route Column</pre>
−	'''Name''': ~~Weight~~<br>'''Type attributes''': integer<br>'''Default''': 100 <br>	+	'''Name''': weight<br>'''Type attributes''': integer<br>'''Default''': 100 <br>