Browse Source

dispatcher: update the default value and docs of ds_latency_estimator_alpha

This is to match the recent adjustement made in "dispatcher: fix ds_latency_estimator_alpha meaning"
Julien Chavanton 1 week ago
parent
commit
02c0e0b1b0

+ 2 - 2
src/modules/dispatcher/dispatcher.c

@@ -105,8 +105,8 @@ static int ds_ping_interval = 0;
 int ds_ping_latency_stats = 0;
 int ds_ping_fr_timeout = 0;
 int ds_retain_latency_stats = 0;
-int ds_latency_estimator_alpha_i = 900;
-float ds_latency_estimator_alpha = 0.9f;
+int ds_latency_estimator_alpha_i = 100;
+float ds_latency_estimator_alpha = 0.1f;
 int ds_probing_mode = DS_PROBE_NONE;
 
 static str ds_ping_reply_codes_str= STR_NULL;

+ 4 - 5
src/modules/dispatcher/doc/dispatcher_admin.xml

@@ -813,15 +813,14 @@ modparam("dispatcher", "ds_retain_latency_stats", 1)
 	<section id="dispatcher.p.ds_latency_estimator_alpha">
 		<title><varname>ds_latency_estimator_alpha</varname> (int)</title>
 		<para>
-		The value to be used to control the memory of the estimator EWMA "exponential weighted moving average" or
-		"the speed at which the older samples are dampened"
-		a good explanation can be found here : http://www.itl.nist.gov/div898/handbook/pmc/section3/pmc324.htm
+		The parameter decides how important each latency ping observation is in the calculation of the EWMA.
+		The higher the value of alpha, the more closely the EWMA tracks the original time series.
 		Because Kamailio doesn't support float parameter types, the value in the parameter is divided by 1000 and stored as float.
-		For example, if you want to set the alpha to be 0.75, use value 750 here.
+		For example, if you want to set the alpha to be 0.25, use value 250 here.
 		</para>
 		<para>
 		<emphasis>
-			Default value is <quote>900 => 0.9</quote>.
+			Default value is <quote>100 => 0.1</quote>.
 		</emphasis>
 		</para>
 		<example>