Skip to content

Commit

Permalink
rtpengine: query rtt per call leg (#2576)
Browse files Browse the repository at this point in the history 
Co-authored-by: Julien Chavanton <jchavanton@subspace.com>
  • Loading branch information
@jchavanton
jchavanton and Julien Chavanton committed Dec 7, 2020
1 parent a2eff90 commit 26a7b41
Show file tree
Hide file tree
Showing 2 changed files with 192 additions and 10 deletions.
185 changes: 175 additions & 10 deletions src/modules/rtpengine/doc/rtpengine_admin.xml
View file
Expand Up @@ -830,7 +830,7 @@ modparam("rtpengine", "mos_min_jitter_pv", "$avp(mos_min_jitter)")
<section id="rtpengine.p.mos_min_roundtrip_pv">
<title><varname>mos_min_roundtrip_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the minimum MOS value was encountered;
</para>
<para>
Expand Down Expand Up @@ -952,7 +952,7 @@ modparam("rtpengine", "mos_max_jitter_pv", "$avp(mos_max_jitter)")
<section id="rtpengine.p.mos_max_roundtrip_pv">
<title><varname>mos_max_roundtrip_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the maximum MOS value was encountered;
</para>
<para>
Expand Down Expand Up @@ -1236,7 +1236,7 @@ modparam("rtpengine", "mos_min_jitter_A_pv", "$avp(mos_min_jitter_A)")
<section id="rtpengine.p.mos_min_roundtrip_A_pv">
<title><varname>mos_min_roundtrip_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the minimum MOS value was encountered;
</para>
<para>
Expand All @@ -1261,6 +1261,33 @@ modparam("rtpengine", "mos_min_roundtrip_A_pv", "$avp(mos_min_roundtrip_A)")
</example>
</section>

<section id="rtpengine.p.mos_min_roundtrip_leg_A_pv">
<title><varname>mos_min_roundtrip_leg_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time of the specific call leg
in microseconds at the time the minimum MOS value was encountered;
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_A_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_min_roundtrip_leg_A_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_min_roundtrip_leg_A_pv", "$avp(mos_min_roundtrip_leg_A)")
...
</programlisting>
</example>
</section>

<section id="rtpengine.p.mos_max_A_pv">
<title><varname>mos_max_A_pv</varname> (string)</title>
Expand Down Expand Up @@ -1378,7 +1405,7 @@ modparam("rtpengine", "mos_max_jitter_A_pv", "$avp(mos_max_jitter_A)")
<section id="rtpengine.p.mos_max_roundtrip_A_pv">
<title><varname>mos_max_roundtrip_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the maximum MOS value was encountered;
</para>
<para>
Expand All @@ -1403,6 +1430,34 @@ modparam("rtpengine", "mos_max_roundtrip_A_pv", "$avp(mos_max_roundtrip_A)")
</example>
</section>

<section id="rtpengine.p.mos_max_roundtrip_leg_A_pv">
<title><varname>mos_max_roundtrip_leg_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time of the specific
call leg in microseconds at the time the maximum MOS value was encountered;
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_A_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_max_roundtrip_leg_A_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_max_roundtrip_leg_A_pv", "$avp(mos_max_roundtrip_leg_A)")
...
</programlisting>
</example>
</section>

<section id="rtpengine.p.mos_average_A_pv">
<title><varname>mos_average_A_pv</varname> (string)</title>
<para>
Expand Down Expand Up @@ -1493,8 +1548,7 @@ modparam("rtpengine", "mos_average_jitter_A_pv", "$avp(mos_average_jitter_A)")
<title><varname>mos_average_roundtrip_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the average (median) packet round-trip
time in milliseconds
present throughout the call.
time in microseconds present throughout the call.
</para>
<para>
There is no default value.
Expand All @@ -1518,6 +1572,34 @@ modparam("rtpengine", "mos_average_roundtrip_A_pv", "$avp(mos_average_roundtrip_
</example>
</section>

<section id="rtpengine.p.mos_average_roundtrip_leg_A_pv">
<title><varname>mos_average_roundtrip_leg_A_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the average (median) packet round-trip
time of the specific call leg in microseconds present throughout the call.
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_A_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_average_roundtrip_leg_A_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_average_roundtrip_leg_A_pv", "$avp(mos_average_roundtrip_leg_A)")
...
</programlisting>
</example>
</section>

<section id="rtpengine.p.mos_average_samples_A_pv">
<title><varname>mos_average_samples_A_pv</varname> (string)</title>
<para>
Expand Down Expand Up @@ -1686,7 +1768,7 @@ modparam("rtpengine", "mos_min_jitter_B_pv", "$avp(mos_min_jitter_B)")
<section id="rtpengine.p.mos_min_roundtrip_B_pv">
<title><varname>mos_min_roundtrip_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the minimum MOS value was encountered;
</para>
<para>
Expand All @@ -1711,6 +1793,34 @@ modparam("rtpengine", "mos_min_roundtrip_B_pv", "$avp(mos_min_roundtrip_B)")
</example>
</section>

<section id="rtpengine.p.mos_min_roundtrip_leg_B_pv">
<title><varname>mos_min_roundtrip_leg_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time of the specific call leg
in microseconds at the time the minimum MOS value was encountered;
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_B_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_min_roundtrip_leg_B_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_min_roundtrip_leg_B_pv", "$avp(mos_min_roundtrip_leg_B)")
...
</programlisting>
</example>
</section>


<section id="rtpengine.p.mos_max_B_pv">
<title><varname>mos_max_B_pv</varname> (string)</title>
Expand Down Expand Up @@ -1828,7 +1938,7 @@ modparam("rtpengine", "mos_max_jitter_B_pv", "$avp(mos_max_jitter_B)")
<section id="rtpengine.p.mos_max_roundtrip_B_pv">
<title><varname>mos_max_roundtrip_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time in milliseconds
The name of a pseudovariable to hold the packet round-trip time in microseconds
at the time the maximum MOS value was encountered;
</para>
<para>
Expand All @@ -1853,6 +1963,34 @@ modparam("rtpengine", "mos_max_roundtrip_B_pv", "$avp(mos_max_roundtrip_B)")
</example>
</section>

<section id="rtpengine.p.mos_max_roundtrip_leg_B_pv">
<title><varname>mos_max_roundtrip_leg_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the packet round-trip time of the specific
call leg in microseconds at the time the maximum MOS value was encountered;
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_A_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_max_roundtrip_leg_B_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_max_roundtrip_leg_B_pv", "$avp(mos_max_roundtrip_leg_B)")
...
</programlisting>
</example>
</section>

<section id="rtpengine.p.mos_average_B_pv">
<title><varname>mos_average_B_pv</varname> (string)</title>
<para>
Expand Down Expand Up @@ -1943,8 +2081,7 @@ modparam("rtpengine", "mos_average_jitter_B_pv", "$avp(mos_average_jitter_B)")
<title><varname>mos_average_roundtrip_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the average (median) packet round-trip
time in milliseconds
present throughout the call.
time in microseconds present throughout the call.
</para>
<para>
There is no default value.
Expand All @@ -1968,6 +2105,34 @@ modparam("rtpengine", "mos_average_roundtrip_B_pv", "$avp(mos_average_roundtrip_
</example>
</section>

<section id="rtpengine.p.mos_average_roundtrip_leg_B_pv">
<title><varname>mos_average_roundtrip_leg_B_pv</varname> (string)</title>
<para>
The name of a pseudovariable to hold the average (median) packet round-trip
time of the specific call leg in microseconds present throughout the call.
</para>
<para>
There is no default value.
</para>
<para>
This value is filled in after invoking <quote>rtpengine_delete</quote>,
<quote>rtpengine_query</quote>, or <quote>rtpengine_manage</quote> if the
command resulted in a deletion of the call (or call branch).
</para>
<para>
Only call legs matching the rtpengine label given in the <quote>mos_B_label_pv</quote>
will be used in calculating this statistics value.
</para>
<example>
<title>Set <varname>mos_average_roundtrip_leg_B_pv</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("rtpengine", "mos_average_roundtrip_leg_B_pv", "$avp(mos_average_roundtrip_leg_B)")
...
</programlisting>
</example>
</section>

<section id="rtpengine.p.mos_average_samples_B_pv">
<title><varname>mos_average_samples_B_pv</varname> (string)</title>
<para>
Expand Down
17 changes: 17 additions & 0 deletions src/modules/rtpengine/rtpengine.c
View file
Expand Up @@ -149,13 +149,15 @@ struct minmax_mos_stats {
str packetloss_param;
str jitter_param;
str roundtrip_param;
str roundtrip_leg_param;
str samples_param;

pv_elem_t *mos_pv;
pv_elem_t *at_pv;
pv_elem_t *packetloss_pv;
pv_elem_t *jitter_pv;
pv_elem_t *roundtrip_pv;
pv_elem_t *roundtrip_leg_pv;
pv_elem_t *samples_pv;
};
struct minmax_mos_label_stats {
Expand All @@ -174,6 +176,7 @@ struct minmax_stats_vals {
long long packetloss;
long long jitter;
long long roundtrip;
long long roundtrip_leg;
long long samples;
long long avg_samples; /* our own running count to average the averages */
};
Expand Down Expand Up @@ -463,15 +466,18 @@ static param_export_t params[] = {
{"mos_min_packetloss_pv", PARAM_STR, &global_mos_stats.min.packetloss_param },
{"mos_min_jitter_pv", PARAM_STR, &global_mos_stats.min.jitter_param },
{"mos_min_roundtrip_pv", PARAM_STR, &global_mos_stats.min.roundtrip_param },
{"mos_min_roundtrip_leg_pv", PARAM_STR, &global_mos_stats.min.roundtrip_leg_param },
{"mos_max_pv", PARAM_STR, &global_mos_stats.max.mos_param },
{"mos_max_at_pv", PARAM_STR, &global_mos_stats.max.at_param },
{"mos_max_packetloss_pv", PARAM_STR, &global_mos_stats.max.packetloss_param },
{"mos_max_jitter_pv", PARAM_STR, &global_mos_stats.max.jitter_param },
{"mos_max_roundtrip_pv", PARAM_STR, &global_mos_stats.max.roundtrip_param },
{"mos_max_roundtrip_leg_pv", PARAM_STR, &global_mos_stats.max.roundtrip_leg_param },
{"mos_average_pv", PARAM_STR, &global_mos_stats.average.mos_param },
{"mos_average_packetloss_pv", PARAM_STR, &global_mos_stats.average.packetloss_param },
{"mos_average_jitter_pv", PARAM_STR, &global_mos_stats.average.jitter_param },
{"mos_average_roundtrip_pv", PARAM_STR, &global_mos_stats.average.roundtrip_param },
{"mos_average_roundtrip_leg_pv", PARAM_STR, &global_mos_stats.average.roundtrip_leg_param },
{"mos_average_samples_pv", PARAM_STR, &global_mos_stats.average.samples_param },

/* designated side A */
Expand All @@ -481,15 +487,18 @@ static param_export_t params[] = {
{"mos_min_packetloss_A_pv", PARAM_STR, &side_A_mos_stats.min.packetloss_param },
{"mos_min_jitter_A_pv", PARAM_STR, &side_A_mos_stats.min.jitter_param },
{"mos_min_roundtrip_A_pv", PARAM_STR, &side_A_mos_stats.min.roundtrip_param },
{"mos_min_roundtrip_leg_A_pv", PARAM_STR, &side_A_mos_stats.min.roundtrip_leg_param },
{"mos_max_A_pv", PARAM_STR, &side_A_mos_stats.max.mos_param },
{"mos_max_at_A_pv", PARAM_STR, &side_A_mos_stats.max.at_param },
{"mos_max_packetloss_A_pv", PARAM_STR, &side_A_mos_stats.max.packetloss_param },
{"mos_max_jitter_A_pv", PARAM_STR, &side_A_mos_stats.max.jitter_param },
{"mos_max_roundtrip_A_pv", PARAM_STR, &side_A_mos_stats.max.roundtrip_param },
{"mos_max_roundtrip_leg_A_pv", PARAM_STR, &side_A_mos_stats.max.roundtrip_leg_param },
{"mos_average_A_pv", PARAM_STR, &side_A_mos_stats.average.mos_param },
{"mos_average_packetloss_A_pv", PARAM_STR, &side_A_mos_stats.average.packetloss_param },
{"mos_average_jitter_A_pv", PARAM_STR, &side_A_mos_stats.average.jitter_param },
{"mos_average_roundtrip_A_pv", PARAM_STR, &side_A_mos_stats.average.roundtrip_param },
{"mos_average_roundtrip_leg_A_pv", PARAM_STR, &side_A_mos_stats.average.roundtrip_leg_param },
{"mos_average_samples_A_pv", PARAM_STR, &side_A_mos_stats.average.samples_param },

/* designated side B */
Expand All @@ -499,15 +508,18 @@ static param_export_t params[] = {
{"mos_min_packetloss_B_pv", PARAM_STR, &side_B_mos_stats.min.packetloss_param },
{"mos_min_jitter_B_pv", PARAM_STR, &side_B_mos_stats.min.jitter_param },
{"mos_min_roundtrip_B_pv", PARAM_STR, &side_B_mos_stats.min.roundtrip_param },
{"mos_min_roundtrip_B_pv", PARAM_STR, &side_B_mos_stats.min.roundtrip_param },
{"mos_max_B_pv", PARAM_STR, &side_B_mos_stats.max.mos_param },
{"mos_max_at_B_pv", PARAM_STR, &side_B_mos_stats.max.at_param },
{"mos_max_packetloss_B_pv", PARAM_STR, &side_B_mos_stats.max.packetloss_param },
{"mos_max_jitter_B_pv", PARAM_STR, &side_B_mos_stats.max.jitter_param },
{"mos_max_roundtrip_B_pv", PARAM_STR, &side_B_mos_stats.max.roundtrip_param },
{"mos_max_roundtrip_leg_B_pv", PARAM_STR, &side_B_mos_stats.max.roundtrip_leg_param },
{"mos_average_B_pv", PARAM_STR, &side_B_mos_stats.average.mos_param },
{"mos_average_packetloss_B_pv", PARAM_STR, &side_B_mos_stats.average.packetloss_param },
{"mos_average_jitter_B_pv", PARAM_STR, &side_B_mos_stats.average.jitter_param },
{"mos_average_roundtrip_B_pv", PARAM_STR, &side_B_mos_stats.average.roundtrip_param },
{"mos_average_roundtrip_leg_B_pv", PARAM_STR, &side_B_mos_stats.average.roundtrip_leg_param },
{"mos_average_samples_B_pv", PARAM_STR, &side_B_mos_stats.average.samples_param },

{0, 0, 0}
Expand Down Expand Up @@ -1925,6 +1937,8 @@ static int minmax_pv_parse(struct minmax_mos_stats *s, int *got_any) {
return -1;
if (pv_parse_var(&s->roundtrip_param, &s->roundtrip_pv, got_any))
return -1;
if (pv_parse_var(&s->roundtrip_leg_param, &s->roundtrip_leg_pv, got_any))
return -1;
if (pv_parse_var(&s->samples_param, &s->samples_pv, got_any))
return -1;
return 0;
Expand Down Expand Up @@ -3272,6 +3286,7 @@ static void avp_print_mos(struct minmax_mos_stats *s, struct minmax_stats_vals *
avp_print_int(s->packetloss_pv, vals->packetloss / vals->avg_samples, msg);
avp_print_int(s->jitter_pv, vals->jitter / vals->avg_samples, msg);
avp_print_int(s->roundtrip_pv, vals->roundtrip / vals->avg_samples, msg);
avp_print_int(s->roundtrip_leg_pv, vals->roundtrip_leg / vals->avg_samples, msg);
avp_print_int(s->samples_pv, vals->samples / vals->avg_samples, msg);
}

Expand All @@ -3287,6 +3302,7 @@ static int decode_mos_vals_dict(struct minmax_stats_vals *vals, bencode_item_t *
vals->packetloss = bencode_dictionary_get_integer(mos_ent, "packet loss", -1);
vals->jitter = bencode_dictionary_get_integer(mos_ent, "jitter", -1);
vals->roundtrip = bencode_dictionary_get_integer(mos_ent, "round-trip time", -1);
vals->roundtrip_leg = bencode_dictionary_get_integer(mos_ent, "round-trip time leg", -1);
vals->samples = bencode_dictionary_get_integer(mos_ent, "samples", -1);
vals->avg_samples = 1;

Expand Down Expand Up @@ -3416,6 +3432,7 @@ static void parse_call_stats_1(struct minmax_mos_label_stats *mmls, bencode_item
average_vals.packetloss += vals_decoded.packetloss;
average_vals.jitter += vals_decoded.jitter;
average_vals.roundtrip += vals_decoded.roundtrip;
average_vals.roundtrip_leg += vals_decoded.roundtrip_leg;
average_vals.samples += vals_decoded.samples;
}

Expand Down

0 comments on commit 26a7b41

Please sign in to comment.